Square Model Context Protocol Server (Beta)

Dieses Projekt folgt dem Model Context Protocol- Standard und ermöglicht KI-Assistenten die Interaktion mit der Connect-API von Square.

Schnellstart

Starten Sie den Square MCP-Server mit npx:

# Basic startup npx square-mcp-server start # With environment configuration ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start # local runs npx /path/to/project/square-mcp-server

Ersetzen Sie YOUR_SQUARE_ACCESS_TOKEN durch Ihren tatsächlichen Square-Zugriffstoken. Sie erhalten Ihren Zugriffstoken gemäß der Anleitung unter Square Access Tokens . Sie können vor der Ausführung des Befehls auch Umgebungsvariablen festlegen.

Related MCP server: Linear MCP Server

Remote-MCP-Server

Square bietet jetzt einen gehosteten Remote-MCP-Server unter:

https://mcp.squareup.com/sse

Das Remote-MCP wird empfohlen, da es die OAuth-Authentifizierung verwendet und Ihnen die direkte Anmeldung mit Ihrem Square-Konto ermöglicht, ohne Zugriffstoken manuell erstellen oder verwalten zu müssen.

Konfigurationsoptionen

Umgebungsvariable	Zweck	Beispiel
`ACCESS_TOKEN`	Ihr Square API-Zugriffstoken	`ACCESS_TOKEN=sq0atp-...`
`SANDBOX`	Verwenden Sie die Square-Sandbox-Umgebung	`SANDBOX=true`
`PRODUCTION`	Verwenden Sie die Square-Produktionsumgebung	`PRODUCTION=true`
`DISALLOW_WRITES`	Auf schreibgeschützte Vorgänge beschränken	`DISALLOW_WRITES=true`
`SQUARE_VERSION`	Geben Sie die Square-API-Version an	`SQUARE_VERSION=2025-04-16`

Integration mit KI-Assistenten

Goose-Integration

So konfigurieren Sie den Square MCP-Server mit Goose :

Remote-MCP

Um das Square Remote MCP in Goose zu installieren, klicken Sie auf einem Computer, auf dem Goose installiert ist, auf diese URL:

goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fsse&id=square_mcp_production_remote&name=Square%20MCP%20Remote&description=Square%20Production%20MCP%20Remote

Oder kopieren Sie die URL und fügen Sie sie in die Adressleiste Ihres Browsers ein.

# Automatic installation npx square-mcp-server install # Get URL for manual installation npx square-mcp-server get-goose-url

Der install aktualisiert Ihre Goose-Konfiguration automatisch.

Claude Desktop Integration

Informationen zur Claude Desktop-Integration finden Sie im Model Context Protocol Quickstart Guide . Fügen Sie diese Konfiguration zu Ihrer claude_desktop_config.json hinzu:

Remote-MCP

{ "mcpServers": { "mcp_square_api": { "command": "npx", "args": ["mcp-remote", "https://mcp.squareup.com/sse"] } } }

Dieser Ansatz ermöglicht Ihnen die direkte Authentifizierung mit den Anmeldeinformationen Ihres Square-Kontos, ohne dass Sie Zugriffstoken verwalten müssen.

Lokales MCP

{ "mcpServers": { "mcp_square_api": { "command": "npx", "args": ["square-mcp-server", "start"], "env": { "ACCESS_TOKEN": "YOUR_SQUARE_ACCESS_TOKEN", "SANDBOX": "true" } } } }

Werkzeugreferenz

Der Square MCP-Server bietet einen optimierten Satz von Tools für die Interaktion mit Square-APIs:

Werkzeug	Beschreibung	Primäre Verwendung
`get_service_info`	Entdecken Sie die für einen Dienst verfügbaren Methoden	Erkundung und Entdeckung
`get_type_info`	Erhalten Sie detaillierte Parameteranforderungen	Anfragevorbereitung
`make_api_request`	Führen Sie API-Aufrufe an Square aus	Durchführen von Operationen

Servicekatalog

Der Square MCP Server bietet Zugriff auf das komplette API-Ökosystem von Square. Detaillierte Informationen zu den einzelnen Diensten finden Sie in der Square API-Dokumentation :

Service	Beschreibung
`applepay`	Apple Pay-Integration
`bankaccounts`	Bankkontoverwaltung
`bookingcustomattributes`	Benutzerdefinierte Attribute für Buchungen
`bookings`	Terminbuchungsverwaltung
`cards`	Zahlungskartenverwaltung
`cashdrawers`	Kassenladenverwaltung
`catalog`	Katalogverwaltung (Artikel, Kategorien usw.)
`checkout`	Kaufabwicklung und Zahlungsabwicklung
`customercustomattributes`	Benutzerdefinierte Attribute für Kunden
`customergroups`	Kundengruppierung
`customersegments`	Kundensegmentierung
`customers`	Kundenmanagement
`devices`	Square-Geräteverwaltung
`disputes`	Bearbeitung von Zahlungsstreitigkeiten
`events`	Ereignisverfolgung
`giftcardactivities`	Tracking der Geschenkkartenaktivität
`giftcards`	Geschenkkartenverwaltung
`inventory`	Bestandsverfolgung
`invoices`	Rechnungsverwaltung
`labor`	Personalmanagement
`locationcustomattributes`	Benutzerdefinierte Attribute für Standorte
`locations`	Standortverwaltung
`loyalty`	Verwaltung von Treueprogrammen
`merchantcustomattributes`	Benutzerdefinierte Attribute für Händler
`merchants`	Händlerkontoverwaltung
`oauth`	Authentifizierung
`ordercustomattributes`	Benutzerdefinierte Attribute für Bestellungen
`orders`	Auftragsverwaltung
`payments`	Zahlungsabwicklung
`payouts`	Auszahlungsmanagement
`refunds`	Rückerstattungsmanagement
`sites`	Website-Integration
`snippets`	Square Online Code-Integration
`subscriptions`	Abonnementverwaltung
`team`	Personalmanagement
`terminal`	Square Terminal-Verwaltung
`vendors`	Lieferantenmanagement
`webhooksubscriptions`	Ereignisbenachrichtigungen

Nutzungsmuster

Für eine optimale Interaktion mit der Square-API über MCP:

Entdecken : Verwenden Sie get_service_info , um verfügbare Methoden zu erkunden
get_service_info(service: "catalog")
Verstehen : Verwenden Sie get_type_info , um Parameteranforderungen zu erfahren
get_type_info(service: "catalog", method: "list")
Ausführen : Verwenden Sie make_api_request , um den Vorgang auszuführen
make_api_request(service: "catalog", method: "list", request: {})

Entwicklung und Debugging

Verwenden des MCP Inspector

Der MCP Inspector bietet eine visuelle Schnittstelle zum Testen:

# Build the project npm run build # Start the inspector with the Square MCP Server npx @modelcontextprotocol/inspector node dist/index.js start

Entwicklungs-Workflow

Klonen Sie das Repository
Abhängigkeiten installieren: npm install
Entwicklungsmodus starten: npm run watch
Führen Sie den Server aus: node dist/index.js start
Testen Sie Ihre Änderungen mit dem MCP Inspector

Beitragen

Dieses Repository wird automatisch aus der OpenAPI-Spezifikation von Square generiert. Beiträge sind willkommen, beachten Sie jedoch, dass Änderungen in den Generator, der diesen Code erzeugt, integriert werden müssen. Bitte eröffnen Sie ein Issue, um die vorgeschlagenen Änderungen zu besprechen, bevor Sie einen Pull Request einreichen.