Square Model Context Protocol Server (Beta)

Square Model Context Protocol Server (Beta)

site icon
2025.05.06 0
TypeScript商业自动化AI 助手集成支付处理订单管理金融服务
Square Model Context Protocol Server (Square MCP Server) 是一个遵循 Model Context Protocol 标准的服务,旨在帮助 AI 助手与 Square 的 Connect API 进行交互。该服务提供了对 Square 完整 API 生态系统的访问,包括支付处理、客户管理、库存跟踪等多种功能。
View on GitHub

Overview

基本能力

产品定位

Square MCP Server 是一个中间件服务,用于桥接 AI 助手与 Square 的商业 API,简化 Square 平台上的商业操作自动化。

核心功能

  • API 交互:提供 get_service_infoget_type_infomake_api_request 等工具,用于探索、理解和执行 Square API 调用。
  • 多环境支持:支持沙盒和生产环境,可通过环境变量配置。
  • OAuth 认证:远程 MCP 服务器支持 OAuth 认证,无需手动管理访问令牌。
  • 读写控制:可通过环境变量限制为只读操作。

适用场景

  • 商业自动化:自动化处理支付、订单、库存等商业操作。
  • AI 助手集成:与 Goose 和 Claude Desktop 等 AI 助手集成,提供 Square 平台的无缝操作体验。
  • 开发调试:使用 MCP Inspector 进行 API 调用的可视化和测试。

工具列表

  • get_service_info:发现服务可用的方法。
  • get_type_info:获取详细的参数要求。
  • make_api_request:执行 Square API 调用。

常见问题解答

  • 如何获取访问令牌:参考 Square Access Tokens 指南。
  • 如何配置沙盒环境:设置 SANDBOX=true 环境变量。
  • 如何限制只读操作:设置 DISALLOW_WRITES=true 环境变量。

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

# 基本启动
npx square-mcp-server start

# 带环境配置
ACCESS_TOKEN=YOUR_SQUARE_ACCESS_TOKEN SANDBOX=true npx square-mcp-server start

# 本地运行
npx /path/to/project/square-mcp-server

调试方式

# 使用 MCP Inspector
npx @modelcontextprotocol/inspector node dist/index.js start

# 开发模式
npm run watch
node dist/index.js start

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。