Сервер контекстного протокола 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: Square Model Context Protocol Server

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

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

https://mcp.squareup.com/sse

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

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

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

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

Чтобы настроить сервер 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:

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

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

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

Для оптимального взаимодействия с 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. Хотя вклады приветствуются, обратите внимание, что изменения необходимо будет внести в генератор, который создает этот код. Пожалуйста, откройте тему, чтобы обсудить предлагаемые изменения, прежде чем отправлять запрос на извлечение.

Maintenance

Resources

• NPM Package
• GitHub Repository
Need Help?
• Reddit Discussion
Related Servers

Tools

• get_service_infoA
• get_type_infoA
• make_api_requestB