Сервер контекстного протокола модели 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 . Вы также можете задать переменные среды перед запуском команды.

Удаленный 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://mcp.squareup.com/sse&id=square_mcp_production_remote&name=Square MCP Remote&description=Square Production MCP Remote

Или скопируйте и вставьте 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:

Откройте для себя : используйте get_service_info для изучения доступных методов.
get_service_info(service: "catalog")
Понять : используйте get_type_info для изучения требований к параметрам
get_type_info(service: "catalog", method: "list")
Выполнить : используйте 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

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

Клонировать репозиторий
Установить зависимости: npm install
Запустить режим разработки: npm run watch
Запустите сервер: node dist/index.js start
Протестируйте свои изменения с помощью MCP Inspector

Внося вклад

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

You must be authenticated.

security – no known vulnerabilities

license - permissive license

quality - confirmed to work

hybrid server

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

Tools

Позволяет помощникам на основе искусственного интеллекта взаимодействовать с API Square Connect через стандарт Model Context Protocol, что позволяет выполнять такие операции, как управление клиентами, обработка платежей и управление запасами.

Related Resources

Reddit Discussion about this server

Related MCP Servers

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
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
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
33
JavaScript
Apache 2.0
Integrator MCP Server
boostspace
-
security
A
license
-
quality
A Model Context Protocol server that allows AI assistants to invoke and interact with Integrator automation workflows through an API connection.
Last updated -
TypeScript
MIT License

View all related MCP servers

Square Model Context Protocol Server

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

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

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

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

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

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

Удаленный MCP

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

Удаленный MCP

Местный МКП

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

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

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

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

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

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

Внося вклад

Tools

Related Resources

Related MCP Servers

Moneybird MCP Server

Kong Konnect MCP Serverofficial

Slack MCP Server

Integrator MCP Server

New MCP Servers

MCP directory API