Square Model Context Protocol Server (Beta)

Name: Square Model Context Protocol Server (Beta)
Author: square

@square

代码仓库

关于 Square Model Context Protocol Server (Beta)

A Model Context Protocol (MCP) server for square

基本信息

分类

其他

许可证

Apache-2.0

运行时

node

传输方式

stdio

发布者

square

配置

使用下面的配置,将此服务器添加到你的 MCP 客户端。

{
  "mcpServers": {
    "square-mcp-server": {
      "command": "npx",
      "args": [
        "square-mcp-server",
        "start"
      ]
    }
  }
}

工具

未检测到工具

工具是从 README 中自动提取的。维护者可以在 ## Tools 标题下列出工具,即可填充这部分内容。

概览

What is Square Model Context Protocol Server (Beta)?

Square Model Context Protocol Server (Beta) is a server that follows the Model Context Protocol (MCP) standard, enabling AI assistants to interact with Square’s Connect API. It is designed for developers who want to manage Square data—such as payments, customers, and inventory—through AI chat interfaces like Goose or Claude Desktop.

How to use Square Model Context Protocol Server (Beta)?

Run the server locally using npx square-mcp-server start, optionally setting environment variables like ACCESS_TOKEN, SANDBOX, PRODUCTION, DISALLOW_WRITES, or SQUARE_VERSION. Alternatively, use the hosted remote MCP server at https://mcp.squareup.com/sse which supports OAuth authentication. Integrate with Goose via npx square-mcp-server install or by copying a goose:// URL. For Claude Desktop, add a local or remote configuration to claude_desktop_config.json. Use the three MCP tools—get_service_info, get_type_info, and make_api_request—in sequence to discover, understand, and execute Square API calls.

Key features of Square Model Context Protocol Server (Beta)

Discover Square API methods with get_service_info
Inspect parameter requirements via get_type_info
Execute any Square API call with make_api_request
Switch between sandbox and production environments
Restrict operations to read-only with DISALLOW_WRITES
Integrates with Goose and Claude Desktop

Use cases of Square Model Context Protocol Server (Beta)

Query customer details and manage segmented lists via AI
Process payments, refunds, and disputes through natural language
Update inventory and catalog items without manual API calls
Manage orders, invoices, and subscriptions from a chat interface
Automate loyalty program adjustments and gift card operations

FAQ from Square Model Context Protocol Server (Beta)

What authentication methods are supported?

Local mode requires a Square access token set as the ACCESS_TOKEN environment variable. The remote MCP server uses OAuth, allowing you to log in with your Square account without manually managing tokens.

Can I use the sandbox environment for testing?

Yes. Set the environment variable SANDBOX=true to run against Square’s sandbox. Alternatively, set PRODUCTION=true for live data.

How can I prevent write operations?

Set DISALLOW_WRITES=true to restrict the server to read-only operations such as listing customers or retrieving payments.

What runtime dependencies are required?

The server runs via Node.js and is invoked with npx. For local development, clone the repo and run npm install followed by npm run build.

Which Square API version is used?

You can specify a particular API version with the SQUARE_VERSION environment variable (e.g., SQUARE_VERSION=2025-04-16). Otherwise, the default version is used.