Skip to main content
Glama
Sign In
enesjakozh

Square Model Context Protocol Server

by square
npmGitHub
TypeScript
Apache 2.0
157
44
OverviewInspectNewSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

Integrations

  • Enables integration with Apple Pay through Square's API, allowing for payment processing via Apple's payment platform.

  • Provides access to Square's complete API ecosystem, enabling interactions with services such as catalog management, customer management, payment processing, order management, inventory tracking, appointment booking, gift cards, loyalty programs, and many other Square business services.

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:

# 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

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.

Opciones de configuración

Variable de entornoObjetivoEjemplo
ACCESS_TOKENSu token de acceso a la API de SquareACCESS_TOKEN=sq0atp-...
SANDBOXUtilice el entorno sandbox de SquareSANDBOX=true
PRODUCTIONUtilice el entorno de producción SquarePRODUCTION=true
DISALLOW_WRITESRestringir a operaciones de solo lecturaDISALLOW_WRITES=true
SQUARE_VERSIONEspecifique la versión de la API de SquareSQUARE_VERSION=2025-04-16

Integración con asistentes de IA

Integración de Goose

Para configurar el servidor Square MCP con Goose :

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

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 :

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

Referencia de herramientas

El servidor Square MCP proporciona un conjunto optimizado de herramientas para interactuar con las API de Square:

HerramientaDescripciónUso principal
get_service_infoDescubra los métodos disponibles para un servicioExploración y descubrimiento
get_type_infoObtenga los requisitos detallados de los parámetrosPreparación de solicitudes
make_api_requestEjecutar llamadas API a SquareRealizar 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:

ServicioDescripción
applepayIntegración con Apple Pay
bankaccountsGestión de cuentas bancarias
bookingcustomattributesAtributos personalizados para reservas
bookingsGestión de reservas de citas
cardsGestión de tarjetas de pago
cashdrawersGestión de caja registradora
catalogGestión de catálogos (artículos, categorías, etc.)
checkoutProcesamiento de pagos y pago
customercustomattributesAtributos personalizados para clientes
customergroupsAgrupación de clientes
customersegmentsSegmentación de clientes
customersGestión de clientes
devicesAdministración de dispositivos Square
disputesManejo de disputas de pago
eventsSeguimiento de eventos
giftcardactivitiesSeguimiento de la actividad de las tarjetas de regalo
giftcardsGestión de tarjetas de regalo
inventorySeguimiento de inventario
invoicesGestión de facturas
laborGestión de la fuerza laboral
locationcustomattributesAtributos personalizados para ubicaciones
locationsGestión de ubicaciones
loyaltyGestión de programas de fidelización
merchantcustomattributesAtributos personalizados para comerciantes
merchantsGestión de cuentas comerciales
oauthAutenticación
ordercustomattributesAtributos personalizados para pedidos
ordersGestión de pedidos
paymentsProcesamiento de pagos
payoutsGestión de pagos
refundsGestión de reembolsos
sitesIntegración de sitios web
snippetsIntegración de códigos de Square Online
subscriptionsGestión de suscripciones
teamGestión de personal
terminalGestión de terminales Square
vendorsGestión de proveedores
webhooksubscriptionsNotificaciones de eventos

Patrón de uso

Para una interacción óptima con la API de Square a través de MCP:

  1. Descubra : utilice get_service_info para explorar los métodos disponibles
    get_service_info(service: "catalog")
  2. Comprender : utilice get_type_info para conocer los requisitos de los parámetros
    get_type_info(service: "catalog", method: "list")
  3. Ejecutar : utilice make_api_request para realizar la operación
    make_api_request(service: "catalog", method: "list", request: {})

Desarrollo y depuración

Uso del inspector MCP

El Inspector MCP proporciona una interfaz visual para realizar pruebas:

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

Flujo de trabajo de desarrollo

  1. Clonar el repositorio
  2. Instalar dependencias: npm install
  3. Iniciar el modo de desarrollo: npm run watch
  4. Ejecute el servidor: node dist/index.js start
  5. 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.

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Tools

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.

  1. Quick Start
    1. Configuration Options
      1. Integration with AI Assistants
        1. Goose Integration
        2. Claude Desktop Integration
      2. Tool Reference
        1. Service Catalog
          1. Usage Pattern
            1. Development and Debugging
              1. Using MCP Inspector
              2. Development Workflow
            2. Contributing

              Related Resources

              Related MCP Servers

              • Tiny TODO MCP

                tkc
                -
                security
                F
                license
                -
                quality
                A Model Context Protocol server that provides persistent task management capabilities for AI assistants, allowing them to create, update, and track tasks beyond their usual context limitations.
                Last updated -
                1
                TypeScript

              • Moneybird MCP Server

                vanderheijden86
                -
                security
                A
                license
                -
                quality
                A Model Context Protocol server that connects AI assistants like Claude to Moneybird accounting software, enabling management of contacts, financial data, products, and business operations through natural language.
                Last updated -
                1
                JavaScript
                MIT License
                • Apple

              • Kong Konnect MCP Serverofficial

                Kong
                A
                security
                A
                license
                A
                quality
                A Model Context Protocol server enabling AI assistants to interact with Kong Konnect's API Gateway, providing tools to query analytics data, inspect configurations, and manage control planes through natural language.
                Last updated -
                10
                22
                TypeScript
                Apache 2.0
                • Apple

              • Slack MCP Server

                ubie-oss
                A
                security
                A
                license
                A
                quality
                A server implementing Model Context Protocol that enables AI assistants to interact with Slack API through a standardized interface, providing tools for messaging, channel management, user information retrieval, and more.
                Last updated -
                9
                18
                JavaScript
                Apache 2.0

              View all related MCP servers

              ID: sbtj6cl8kw