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

Большинству людей стоит использовать размещённый сервер. Square запускает удалённый MCP-сервер по адресу https://mcp.squareup.com/mcp с входом в OAuth; см. документацию Square MCP для настройки с вашим AI-ассистентом. Этот репозиторий — локальный, самостоятельный сервер: отправная точка, если вы хотите запустить собственную копию. Изменения кода проходят через генератор, описанный в разделе «Вклад».

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

Запустите и запустите локальный сервер с помощью npx. Это запускает сервер на вашем собственном компьютере с вашим собственным токеном доступа; для хостинга сервера см. примечание выше.

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

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

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

Рекомендуется использовать удалённый сервер: он использует OAuth, то есть вы входите с аккаунта Square, а не создаёте и управляете токенами доступа.

Square Model Context Protocol Server (Beta)

This project follows the Model Context Protocol standard, allowing AI assistants to interact with Square’s connect API.

Most people should use the hosted server. Square runs a remote MCP server at https://mcp.squareup.com/mcp with OAuth sign-in; see the Square MCP documentation for setup with your AI assistant. This repository is the local, self-hosted server: a starting point if you want to run your own copy. Code changes go through the generator described under Contributing.

Quick Start

Get up and running with the local server using npx. This runs the server on your own machine with your own access token; for the hosted server, see the note above.

# 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

Replace YOUR_SQUARE_ACCESS_TOKEN with your actual Square access token. You can obtain your access token by following the guide at Square Access Tokens. You can also set environment variables before running the command.

Remote MCP Server

Square offers a hosted remote MCP server at:

https://mcp.squareup.com/mcp

The remote server is recommended: it uses OAuth, so you sign in with your Square account instead of creating and managing access tokens. Setup guides for Claude, ChatGPT, Goose and other assistants are in the Square MCP documentation. The older https://mcp.squareup.com/sse endpoint is still served for existing SSE configurations.

Configuration Options

Integration with AI Assistants

Goose Integration

To configure the Square MCP Server with Goose:

Remote MCP

To install the Square remote MCP in Goose, click this URL on a computer where Goose is installed: