Square

officiel

Un serveur Model Context Protocol (MCP) pour Square.

Que pouvez-vous faire avec Square MCP ?

Découvrir les méthodes de l’API Square — Demandez à votre assistant d’explorer les opérations disponibles pour tout service Square, comme le catalogue ou les paiements, en utilisant get_service_info.
Comprendre les paramètres de requête — Faites rechercher par votre assistant les exigences détaillées des paramètres pour une méthode API spécifique avant d’effectuer un appel, via get_type_info.
Exécuter des appels à l’API Square — Demandez à votre assistant d’effectuer des opérations comme lister l’inventaire ou créer une commande via make_api_request.
Se connecter au MCP Square hébergé — Configurez votre assistant IA pour qu’il s’authentifie auprès de votre compte Square via OAuth en utilisant le serveur distant à https://mcp.squareup.com/mcp.

Serveur MCP hébergé

npx add-mcp 'https://mcp.squareup.com/sse' --transport sse

S’installe dans Claude Code, Codex, Cursor et plus

Documentation

Serveur Square Model Context Protocol (Bêta)

Ce projet suit la norme Model Context Protocol, permettant aux assistants IA d'interagir avec l'API connect de Square.

La plupart des utilisateurs devraient utiliser le serveur hébergé. Square exécute un serveur MCP distant à https://mcp.squareup.com/mcp avec connexion OAuth ; consultez la documentation Square MCP pour la configuration avec votre assistant IA. Ce dépôt est le serveur local auto-hébergé : un point de départ si vous souhaitez exécuter votre propre copie. Les modifications de code passent par le générateur décrit dans la section Contribuer.

Square Model Context Protocol Server MCP server

Démarrage rapide

Mettez en place et exécutez le serveur local avec npx. Cela exécute le serveur sur votre propre machine avec votre propre jeton d'accès ; pour le serveur hébergé, voir la note ci-dessus.

# 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

Remplacez YOUR_SQUARE_ACCESS_TOKEN par votre véritable jeton d'accès Square. Vous pouvez obtenir votre jeton d'accès en suivant le guide sur Jetons d'accès Square. Vous pouvez également définir des variables d'environnement avant d'exécuter la commande.

Serveur MCP distant

Square propose un serveur MCP distant hébergé à :

https://mcp.squareup.com/mcp

Le serveur distant est recommandé : il utilise OAuth, vous vous connectez donc avec votre compte Square au lieu de créer et gérer des jetons d'accès. Les guides de configuration pour Claude, ChatGPT, Goose et d'autres assistants se trouvent dans la documentation Square MCP. L'ancien point de terminaison https://mcp.squareup.com/sse est toujours servi pour les configurations SSE existantes.

Options de configuration

Variable d'environnement	Objectif	Exemple
`ACCESS_TOKEN`	Votre jeton d'accès API Square	`ACCESS_TOKEN=sq0atp-...`
`SANDBOX`	Utiliser l'environnement sandbox Square	`SANDBOX=true`
`PRODUCTION`	Utiliser l'environnement de production Square	`PRODUCTION=true`
`DISALLOW_WRITES`	Restreindre aux opérations en lecture seule	`DISALLOW_WRITES=true`
`SQUARE_VERSION`	Spécifier la version de l'API Square	`SQUARE_VERSION=2025-04-16`

Intégration avec les assistants IA

Intégration Goose

Pour configurer le serveur MCP Square avec Goose :

MCP distant

Pour installer le MCP distant Square dans Goose, cliquez sur cette URL sur un ordinateur où Goose est installé :

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

Ou copiez et collez l'URL dans la barre d'adresse de votre navigateur.

Les commandes ci-dessous configurent le serveur local (npx square-mcp-server start), pas le serveur hébergé :

# Automatic installation
npx square-mcp-server install

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

La commande install met automatiquement à jour votre configuration Goose.

Intégration Claude Desktop

Pour l'intégration Claude Desktop, consultez le Guide de démarrage rapide Model Context Protocol. Ajoutez cette configuration à votre claude_desktop_config.json :

MCP distant

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

Cette approche vous permet de vous authentifier directement avec vos identifiants de compte Square sans avoir à gérer des jetons d'accès.

MCP local

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

Référence des outils

Le serveur MCP Square fournit un ensemble rationalisé d'outils pour interagir avec les API Square :

Outil	Description	Utilisation principale
`get_service_info`	Découvrir les méthodes disponibles pour un service	Exploration et découverte
`get_type_info`	Obtenir les exigences détaillées des paramètres	Préparation des requêtes
`make_api_request`	Exécuter des appels API vers Square	Réalisation d'opérations

Catalogue des services

Le serveur MCP Square donne accès à l'écosystème API complet de Square. Consultez la Documentation API Square pour des informations détaillées sur chaque service :

Service	Description
`applepay`	Intégration Apple Pay
`bankaccounts`	Gestion des comptes bancaires
`bookingcustomattributes`	Attributs personnalisés pour les réservations
`bookings`	Gestion des rendez-vous
`cards`	Gestion des cartes de paiement
`cashdrawers`	Gestion du tiroir-caisse
`catalog`	Gestion du catalogue (articles, catégories, etc.)
`checkout`	Traitement des paiements et des commandes
`customercustomattributes`	Attributs personnalisés pour les clients
`customergroups`	Regroupement des clients
`customersegments`	Segmentation des clients
`customers`	Gestion des clients
`devices`	Gestion des appareils Square
`disputes`	Gestion des litiges de paiement
`events`	Suivi des événements
`giftcardactivities`	Suivi de l'activité des cartes cadeaux
`giftcards`	Gestion des cartes cadeaux
`inventory`	Suivi des stocks
`invoices`	Gestion des factures
`labor`	Gestion des effectifs
`locationcustomattributes`	Attributs personnalisés pour les emplacements
`locations`	Gestion des emplacements
`loyalty`	Gestion du programme de fidélité
`merchantcustomattributes`	Attributs personnalisés pour les marchands
`merchants`	Gestion des comptes marchands
`oauth`	Authentification
`ordercustomattributes`	Attributs personnalisés pour les commandes
`orders`	Gestion des commandes
`payments`	Traitement des paiements
`payouts`	Gestion des versements
`refunds`	Gestion des remboursements
`sites`	Intégration de sites web
`snippets`	Intégration Square Online Code
`subscriptions`	Gestion des abonnements
`team`	Gestion du personnel
`terminal`	Gestion de Square Terminal
`vendors`	Gestion des fournisseurs
`webhooksubscriptions`	Notifications d'événements

Modèle d'utilisation

Pour une interaction optimale avec l'API Square via MCP :

Découvrir : Utilisez get_service_info pour explorer les méthodes disponibles
```
get_service_info(service: "catalog")
```
Comprendre : Utilisez get_type_info pour apprendre les exigences des paramètres
```
get_type_info(service: "catalog", method: "list")
```

Exécuter : Utilisez make_api_request pour effectuer l'opération

make_api_request(service: "catalog", method: "list", request: {})

Développement et débogage

Utilisation de MCP Inspector

Le MCP Inspector fournit une interface visuelle pour les tests :

# Build the project
npm run build

# Start the inspector with the Square MCP Server
npx @modelcontextprotocol/inspector node dist/index.js start

Flux de développement

Clonez le dépôt
Installez les dépendances : npm install
Démarrez le mode développement : npm run watch
Exécutez le serveur : node dist/index.js start
Testez vos modifications à l'aide de MCP Inspector

Contribuer

Ce dépôt est généré automatiquement à partir de la spécification OpenAPI de Square. Bien que les contributions soient les bienvenues, veuillez noter que les modifications devront être intégrées au générateur qui produit ce code. Veuillez ouvrir un problème pour discuter des modifications proposées avant de soumettre une demande d'extraction.