Servidor de protocolo de contexto del modelo cuadrado (Beta)
Este proyecto sigue el estándar del Protocolo de Contexto de Modelo , lo que permite a los asistentes de IA interactuar con la API de conexión de Square.
Inicio rápido
Comience a utilizar el servidor Square MCP usando npx:
Reemplace YOUR_SQUARE_ACCESS_TOKEN
con su token de acceso de Square. Puede obtener su token de acceso siguiendo la guía en Tokens de Acceso de Square . También puede configurar variables de entorno antes de ejecutar el comando.
Servidor MCP remoto
Square ahora ofrece un servidor MCP remoto alojado en:
Se recomienda el MCP remoto ya que utiliza autenticación OAuth, lo que le permite iniciar sesión con su cuenta Square directamente sin tener que crear o administrar tokens de acceso manualmente.
Opciones de configuración
Variable de entorno | Objetivo | Ejemplo |
---|---|---|
ACCESS_TOKEN | Su token de acceso a la API de Square | ACCESS_TOKEN=sq0atp-... |
SANDBOX | Utilice el entorno sandbox de Square | SANDBOX=true |
PRODUCTION | Utilice el entorno de producción Square | PRODUCTION=true |
DISALLOW_WRITES | Restringir a operaciones de solo lectura | DISALLOW_WRITES=true |
SQUARE_VERSION | Especifique la versión de la API de Square | SQUARE_VERSION=2025-04-16 |
Integración con asistentes de IA
Integración de Goose
Para configurar el servidor Square MCP con Goose :
MCP remoto
Para instalar el MCP remoto Square en Goose, haga clic en esta URL en una computadora donde esté instalado Goose:
O copie y pegue la URL en la barra de direcciones de su navegador.
El comando install
actualiza automáticamente la configuración de Goose.
Integración de escritorio de Claude
Para la integración con Claude Desktop, consulte la Guía de inicio rápido del Protocolo de Contexto de Modelo . Agregue esta configuración a su claude_desktop_config.json
:
MCP remoto
Este enfoque le permite autenticarse directamente con las credenciales de su cuenta Square sin necesidad de administrar tokens de acceso.
MCP local
Referencia de herramientas
El servidor Square MCP proporciona un conjunto optimizado de herramientas para interactuar con las API de Square:
Herramienta | Descripción | Uso principal |
---|---|---|
get_service_info | Descubra los métodos disponibles para un servicio | Exploración y descubrimiento |
get_type_info | Obtenga los requisitos de parámetros detallados | Preparación de solicitudes |
make_api_request | Ejecutar llamadas API a Square | Realizar operaciones |
Catálogo de servicios
El servidor MCP de Square proporciona acceso a todo el ecosistema de API de Square. Consulte la documentación de la API de Square para obtener información detallada sobre cada servicio:
Servicio | Descripción |
---|---|
applepay | Integración con Apple Pay |
bankaccounts | Gestión de cuentas bancarias |
bookingcustomattributes | Atributos personalizados para reservas |
bookings | Gestión de reservas de citas |
cards | Gestión de tarjetas de pago |
cashdrawers | Gestión de caja registradora |
catalog | Gestión de catálogos (artículos, categorías, etc.) |
checkout | Procesamiento de pagos y pago |
customercustomattributes | Atributos personalizados para clientes |
customergroups | Agrupación de clientes |
customersegments | Segmentación de clientes |
customers | Gestión de clientes |
devices | Administración de dispositivos Square |
disputes | Manejo de disputas de pago |
events | Seguimiento de eventos |
giftcardactivities | Seguimiento de la actividad de las tarjetas de regalo |
giftcards | Gestión de tarjetas de regalo |
inventory | Seguimiento de inventario |
invoices | Gestión de facturas |
labor | Gestión de la fuerza laboral |
locationcustomattributes | Atributos personalizados para ubicaciones |
locations | Gestión de ubicaciones |
loyalty | Gestión de programas de fidelización |
merchantcustomattributes | Atributos personalizados para comerciantes |
merchants | Gestión de cuentas comerciales |
oauth | Autenticación |
ordercustomattributes | Atributos personalizados para pedidos |
orders | Gestión de pedidos |
payments | Procesamiento de pagos |
payouts | Gestión de pagos |
refunds | Gestión de reembolsos |
sites | Integración de sitios web |
snippets | Integración de códigos de Square Online |
subscriptions | Gestión de suscripciones |
team | Gestión de personal |
terminal | Gestión de terminales Square |
vendors | Gestión de proveedores |
webhooksubscriptions | Notificaciones de eventos |
Patrón de uso
Para una interacción óptima con la API de Square a través de MCP:
- Descubra : utilice
get_service_info
para explorar los métodos disponibles - Comprender : utilice
get_type_info
para conocer los requisitos de los parámetros - Ejecutar : utilice
make_api_request
para realizar la operación
Desarrollo y depuración
Uso del inspector MCP
El Inspector MCP proporciona una interfaz visual para realizar pruebas:
Flujo de trabajo de desarrollo
- Clonar el repositorio
- Instalar dependencias:
npm install
- Iniciar el modo de desarrollo:
npm run watch
- Ejecute el servidor:
node dist/index.js start
- Pruebe sus cambios utilizando el Inspector MCP
Contribuyendo
Este repositorio se genera automáticamente a partir de la especificación OpenAPI de Square. Si bien se agradecen las contribuciones, tenga en cuenta que los cambios deberán incorporarse al generador que produce este código. Abra una incidencia para discutir los cambios propuestos antes de enviar una solicitud de incorporación de cambios.
hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Permite que los asistentes de IA interactúen con la API Connect de Square a través del estándar Model Context Protocol, lo que permite operaciones como administrar clientes, procesar pagos y manejar inventario.
- Inicio rápido
- Servidor MCP remoto
- Opciones de configuración
- Integración con asistentes de IA
- Referencia de herramientas
- Catálogo de servicios
- Patrón de uso
- Desarrollo y depuración
- Contribuyendo
Related Resources
Related MCP Servers
- AsecurityFlicenseAqualityImplements the Model Context Protocol to allow AI models to access and interact with blockchain data, including reading contract states, retrieving events, and accessing transaction information across various networks.Last updated -1068957TypeScript
- -securityFlicense-qualityA Model Context Protocol server implementation that enables AI assistants to interact with Linear project management systems, allowing them to create, retrieve, and modify data related to issues, projects, teams, and users.Last updated -303TypeScript
- -securityFlicense-qualityEnables AI models to interact with Linear for issue tracking and project management through the Model Context Protocol, supporting capabilities like creating issues, searching, managing sprints, and bulk updating statuses.Last updated -5TypeScript
- -securityAlicense-qualityEnables AI assistants to interact with Slack workspaces through the Model Context Protocol, providing tools for reading/sending messages, managing channels, and accessing Slack API functionality.Last updated -PythonMIT License