Square Model Context Protocol Server

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

该项目遵循模型上下文协议标准，允许AI助手与Square的连接API进行交互。

快速入门

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

将YOUR_SQUARE_ACCESS_TOKEN替换为你实际的 Square 访问令牌。你可以按照Square 访问令牌中的指南获取访问令牌。你也可以在运行命令之前设置环境变量。

远程 MCP 服务器

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

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

配置选项

与人工智能助手集成

鹅集成

要使用Goose配置 Square MCP 服务器：

远程 MCP

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

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 复制并粘贴到浏览器的地址栏中。

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

Claude 桌面集成

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

远程 MCP

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

本地 MCP

工具参考

Square MCP 服务器提供了一套简化的工具用于与 Square API 交互：

服务目录

Square MCP 服务器提供对 Square 完整API 生态系统的访问。查看Square API 文档，了解各项服务的详细信息：

使用模式

为了通过 MCP 与 Square API 实现最佳交互：

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提供了一个可视化的测试界面：

开发工作流程

1. 克隆存储库
2. 安装依赖项： npm install
3. 启动开发模式： npm run watch
4. 运行服务器： node dist/index.js start
5. 使用 MCP 检查器测试您的更改

贡献

此代码库根据 Square 的 OpenAPI 规范自动生成。欢迎贡献代码，但请注意，修改需要合并到生成此代码的生成器中。请在提交拉取请求之前，先创建一个问题来讨论建议的修改。