Skip to main content
Glama
square

Square Model Context Protocol Server

Official
by square

Сервер контекстного протокола Square Model (бета)

Этот проект соответствует стандарту Model Context Protocol , позволяя помощникам на основе искусственного интеллекта взаимодействовать с API-интерфейсом Square Connect.

Быстрый старт

Начните работу с сервером Square MCP с помощью 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

Замените YOUR_SQUARE_ACCESS_TOKEN на ваш фактический токен доступа Square. Вы можете получить свой токен доступа, следуя руководству Square Access Tokens . Вы также можете задать переменные среды перед запуском команды.

Related MCP server: Fireblocks MCP Server

Удаленный MCP-сервер

Square теперь предлагает размещенный удаленный сервер MCP по адресу:

https://mcp.squareup.com/sse

Рекомендуется использовать удаленный MCP, поскольку он использует аутентификацию OAuth, что позволяет вам входить в систему напрямую с помощью учетной записи Square, без необходимости вручную создавать или управлять токенами доступа.

Параметры конфигурации

Переменная среды

Цель

Пример

ACCESS_TOKEN

Ваш токен доступа к API Square

ACCESS_TOKEN=sq0atp-...

SANDBOX

Используйте среду песочницы Square

SANDBOX=true

PRODUCTION

Используйте производственную среду Square

PRODUCTION=true

DISALLOW_WRITES

Ограничить операции только для чтения

DISALLOW_WRITES=true

SQUARE_VERSION

Укажите версию API Square

SQUARE_VERSION=2025-04-16

Интеграция с помощниками на основе искусственного интеллекта

Интеграция гуся

Чтобы настроить сервер Square MCP с помощью Goose :

Удаленный MCP

Чтобы установить удаленный MCP Square в Goose, щелкните этот URL-адрес на компьютере, где установлен Goose:

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

Или скопируйте и вставьте URL в адресную строку браузера.

# Automatic installation
npx square-mcp-server install

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

Команда install автоматически обновляет конфигурацию Goose.

Интеграция рабочего стола Клода

Для интеграции Claude Desktop см. Model Context Protocol Quickstart Guide . Добавьте эту конфигурацию в ваш claude_desktop_config.json :

Удаленный MCP

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

Такой подход позволяет вам проходить аутентификацию напрямую с использованием учетных данных вашей учетной записи Square, без необходимости управления токенами доступа.

Местный МКП

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

Справочник по инструментам

Сервер Square MCP предоставляет оптимизированный набор инструментов для взаимодействия с API Square:

Инструмент

Описание

Основное использование

get_service_info

Откройте для себя методы, доступные для услуги

Исследования и открытия

get_type_info

Получить подробные требования к параметрам

Подготовка запроса

make_api_request

Выполнение вызовов API к Square

Выполнение операций

Каталог услуг

Square MCP Server обеспечивает доступ к полной экосистеме API Square. Ознакомьтесь с документацией API Square для получения подробной информации о каждой услуге:

Услуга

Описание

applepay

Интеграция Apple Pay

bankaccounts

Управление банковским счетом

bookingcustomattributes

Пользовательские атрибуты для бронирований

bookings

Управление записью на прием

cards

Управление платежными картами

cashdrawers

Управление денежным ящиком

catalog

Управление каталогом (товары, категории и т. д.)

checkout

Оформление заказа и обработка платежей

customercustomattributes

Пользовательские атрибуты для клиентов

customergroups

Группировка клиентов

customersegments

Сегментация клиентов

customers

Управление клиентами

devices

Управление квадратными устройствами

disputes

Разрешение споров по платежам

events

Отслеживание событий

giftcardactivities

Отслеживание активности подарочных карт

giftcards

Управление подарочными картами

inventory

Отслеживание инвентаря

invoices

Управление счетами

labor

Управление персоналом

locationcustomattributes

Пользовательские атрибуты для местоположений

locations

Управление местоположением

loyalty

Управление программой лояльности

merchantcustomattributes

Пользовательские атрибуты для продавцов

merchants

Управление торговыми счетами

oauth

Аутентификация

ordercustomattributes

Пользовательские атрибуты для заказов

orders

Управление заказами

payments

Обработка платежей

payouts

Управление выплатами

refunds

Управление возвратом средств

sites

Интеграция с веб-сайтом

snippets

Интеграция Square Online Code

subscriptions

Управление подпиской

team

Управление персоналом

terminal

Управление терминалом Square

vendors

Управление поставщиками

webhooksubscriptions

Уведомления о событиях

Модель использования

Для оптимального взаимодействия с API Square через MCP:

  1. Откройте для себя : используйте get_service_info для изучения доступных методов.

    get_service_info(service: "catalog")
  2. Понять : используйте get_type_info для изучения требований к параметрам

    get_type_info(service: "catalog", method: "list")
  3. Выполнить : используйте make_api_request для выполнения операции.

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

Разработка и отладка

Использование MCP-инспектора

MCP Inspector предоставляет визуальный интерфейс для тестирования:

# Build the project
npm run build

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

Рабочий процесс разработки

  1. Клонировать репозиторий

  2. Установить зависимости: npm install

  3. Запустить режим разработки: npm run watch

  4. Запустите сервер: node dist/index.js start

  5. Протестируйте свои изменения с помощью MCP Inspector

Внося вклад

Этот репозиторий автоматически сгенерирован из спецификации OpenAPI Square. Хотя вклады приветствуются, обратите внимание, что изменения необходимо будет внести в генератор, который создает этот код. Пожалуйста, откройте тему, чтобы обсудить предлагаемые изменения, прежде чем отправлять запрос на извлечение.

Available Tools

3 tools
get_service_infoA

Get information about a Square API service. Call me before trying to get type info

ParametersJSON Schema
NameRequiredDescriptionDefault
serviceYesThe Square API service category (e.g., 'catalog', 'payments')

TDQS

A3.7/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations provided, so description must disclose behavior. It only says 'get information', without mentioning whether it's read-only, idempotent, or any side effects. Minimal transparency.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two efficient sentences: first states purpose, second provides usage guidance. No wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Adequate for a simple info tool with one parameter, but lacks description of the output format or any additional behavioral context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 100% description coverage for the only parameter, so baseline is 3. Tool description does not add extra meaning beyond the schema parameter description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Describes a specific action: getting info about a Square API service. Explicitly differentiates from sibling tool get_type_info by telling the agent to call this before that.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear directive to call this before get_type_info, indicating proper ordering. However, no guidance on when not to use or alternatives like make_api_request.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

get_type_infoA

Get type information for a Square API method. You must call this before calling the make_api_request tool.

ParametersJSON Schema
NameRequiredDescriptionDefault
serviceYesThe Square API service category (e.g., 'catalog', 'payments')
methodYesThe API method to call (e.g., 'list', 'create')

TDQS

A3.5/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description must cover behavior. It states it 'gets type information' but does not disclose whether it is read-only, any side effects, or what the response structure looks like, leaving significant gaps.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, front-loaded with purpose and a clear usage instruction. Every sentence adds value with no wasted words.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple prerequisite tool, the description is acceptable but lacks detail on return values and behavioral context. Given no output schema, the agent might need more info to effectively use the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, with both parameters described. The description adds no additional information beyond the schema, so baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it gets type information for a Square API method, and the prerequisite relationship with make_api_request distinguishes it from sibling tools, though it does not specify what 'type information' entails.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly instructs the agent to call this tool before make_api_request, providing clear usage context. However, it does not mention when not to use it or alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

make_api_requestB

Unified tool for all Square API operations. Be sure to get types before calling. Available services: applepay, bankaccounts, bookingcustomattributes, bookings, cards, cashdrawers, catalog, checkout, customercustomattributes, customergroups, customersegments, customers, devices, disputes, events, giftcardactivities, giftcards, inventory, invoices, labor, locationcustomattributes, locations, loyalty, merchantcustomattributes, merchants, oauth, ordercustomattributes, orders, payments, payouts, refunds, sites, snippets, subscriptions, team, terminal, vendors, webhooksubscriptions.

ParametersJSON Schema
NameRequiredDescriptionDefault
serviceYesThe Square API service category (e.g., 'catalog', 'payments')
methodYesThe API method to call (e.g., 'list', 'create')
requestNoThe request object for the API call.

TDQS

B3.3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries full burden but only states it is a unified tool and lists services. It does not disclose that it makes HTTP calls, requires authentication, can modify data, or has rate limits. Minimal behavioral context is provided.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise—two sentences with no superfluous words. It front-loads the core purpose and then lists services efficiently.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite the tool's complexity (any API operation), the description lacks details on return values, how to structure the request object, or supported methods beyond 'list' and 'create' implied. Sibling tools exist but the description does not fully compensate for missing output schema or behavioral specifics.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, but the description adds value by enumerating all available services, which is absent as enum constraints in the schema. This helps the agent select valid service values, going beyond the generic schema description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states it is a unified tool for all Square API operations, clearly indicating its purpose as a general-purpose API caller. It distinguishes from sibling tools (get_service_info, get_type_info) by specifying it performs operations rather than information retrieval.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description advises to 'get types before calling,' providing a prerequisite but not explicit when-to-use or when-not-to-use guidance. It implies this is the primary tool for API calls but does not contrast with alternatives beyond the mention of getting types.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. 3 tool updates
    • First observedget_service_info
    • First observedget_type_info
    • First observedmake_api_request

TDQS

A3.8/5.0
Disambiguation5/5

Each tool has a distinct and clearly defined role in the workflow (service info, type info, API request), with no overlap in purpose.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern (get_service_info, get_type_info, make_api_request), using snake_case throughout.

Tool Count4/5

Three tools is minimal but appropriate for a unified API wrapper, as the tools cover the essential introspection and request workflow.

Completeness5/5

The tool set covers the full lifecycle: discover services, get type information, and make API requests. No obvious gaps for the intended purpose.

Maintenance

ActivityInactive
ResponsivenessUnresponsive

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

  • A
    license
    B
    quality
    D
    maintenance
    Enables AI assistants to interact with Cyoda platform entities and workflows through the Model Context Protocol, supporting entity management, workflow execution, and data synchronization.
    13
    1
    Apache 2.0
  • A
    license
    Not graded
    quality
    C
    maintenance
    Enables AI assistants to securely interact with Fireblocks services through the Model Context Protocol, supporting transaction management, vault and exchange account queries, network connections, and workspace user management.
    23
    10
    MIT
  • F
    license
    Not graded
    quality
    D
    maintenance
    Enables AI agents to perform CRM operations like creating contacts, managing deals, and updating leads through natural language using the Model Context Protocol.
    4
    -

Latest Blog Posts

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