Square MCP Server

Square模型上下文协议服务器（测试版）

该项目遵循 模型上下文协议 标准，允许人工智能助手与Square的connect API进行交互。

快速开始

使用npx启动并运行Square MCP服务器：

# 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访问令牌。您还可以在运行命令之前设置环境变量。

远程MCP服务器

Square现在提供托管远程MCP服务器：

https://mcp.squareup.com/sse

建议使用远程MCP，因为它使用OAuth身份验证，允许您直接使用Square帐户登录，而无需手动创建或管理访问令牌。

配置选项

与AI助手集成

鹅集成

配置Square MCP服务器 鹅:

远程MCP

要在Goose中安装Square远程MCP，请在安装了Goose的计算机上单击以下URL：

goose://extension?cmd=npx&arg=mcp-remote&arg=https%3A%2F%2Fmcp.squareup.com%2Fsse&id=square_mcp_production _ remote&name=square%20MCP%20远程&描述=square%20生产%20MCP/20远程

或者将URL复制并粘贴到浏览器的地址栏中。

# Automatic installation
npx square-mcp-server install

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

这 install 命令会自动更新Goose配置。

Claude桌面集成

有关Claude Desktop集成，请参阅 模型上下文协议快速入门指南。将此配置添加到您的 claude_desktop_config.json:

远程MCP

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

这种方法允许您直接使用Square帐户凭据进行身份验证，而无需管理访问令牌。

本地MCP

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

工具参考

Square MCP Server为与Square API交互提供了一套简化的工具：

服务目录

Square MCP服务器提供对Square完整 API生态系统.看看 Square API文档 有关每项服务的详细信息：

使用模式

为了通过MCP与Square API进行最佳互动：

1. 发现：使用 get_service_info 探索可用的方法

   get_service_info(service: "catalog")

1. 理解：使用 get_type_info 了解参数要求

   get_type_info(service: "catalog", method: "list")

1. 执行：使用 make_api_request 执行操作

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

开发与调试

使用MCP检查器

这 MCP检查员 提供了一个用于测试的可视化界面：

# 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检查器测试您的更改

贡献

此存储库是根据Square的OpenAPI规范自动生成的。虽然欢迎贡献，但请注意，需要将更改合并到生成此代码的生成器中。在提交pull请求之前，请打开一个问题来讨论拟议的更改。