Skip to main content
Glama
deenesjakoruzh

Square Model Context Protocol Server

Official
by square
npmGitHub
TypeScript
Apache 2.0
66
77
OverviewInspectNewEndpointsSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

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.

Servidor MCP remoto

Square ahora ofrece un servidor MCP remoto alojado en:

https://mcp.squareup.com/sse

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:

ganso://extensión?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

O copie y pegue la URL en la barra de direcciones de su navegador.

# 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 :

MCP remoto

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

Este enfoque le permite autenticarse directamente con las credenciales de su cuenta Square sin necesidad de administrar tokens de acceso.

MCP local

{ "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:

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:

  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.

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

How are these scores calculated?

hybrid server

The server is able to function both locally and remotely, depending on the configuration or use case.

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. Inicio rápido
    1. Servidor MCP remoto
      1. Opciones de configuración
        1. Integración con asistentes de IA
          1. Integración de Goose
          2. Integración de escritorio de Claude
        2. Referencia de herramientas
          1. Catálogo de servicios
            1. Patrón de uso
              1. Desarrollo y depuración
                1. Uso del inspector MCP
                2. Flujo de trabajo de desarrollo
              2. Contribuyendo

                Related Resources

                Related MCP Servers

                • Bankless Onchain MCP Serverofficial

                  Bankless
                  A
                  security
                  F
                  license
                  A
                  quality
                  Implements 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 -
                  10
                  65
                  64

                • Linear MCP Server

                  emmett-deen
                  -
                  security
                  F
                  license
                  -
                  quality
                  A 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 -
                  8
                  3

                • Linear MCP Integration Server

                  skspade
                  -
                  security
                  F
                  license
                  -
                  quality
                  Enables 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 -
                  5

                • Slack MCP Server

                  MNizarSall
                  -
                  security
                  A
                  license
                  -
                  quality
                  Enables 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 -
                  1
                  MIT License

                View all related MCP servers

                New MCP Servers

                MCP directory API

                We provide all the information about MCP servers via our MCP API.

                curl -X GET 'https://glama.ai/api/mcp/v1/servers/square/square-mcp-server'

                If you have feedback or need assistance with the MCP directory API, please join our Discord server