使用说明
项目简介
SumUp Agent Toolkit MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器端应用,它允许 AI Agent 通过标准化的 MCP 协议与 SumUp API 进行交互。该服务器提供了一系列工具,使 AI Agent 能够执行如检索交易详情、创建退款、查询商户信息等操作,从而增强 AI 在支付工作流程中的智能化应用。
主要功能点
- 资源管理: 托管 SumUp API 文档和 OpenAPI 规范作为资源,供 LLM 客户端访问,以了解 SumUp API 的功能和用法。
- 工具注册与执行: 注册了一系列预定义的工具,如 'retrieve_checkout', 'list_transactions', 'create_refunds', 'retrieve_merchant_profile',允许 LLM 客户端调用这些工具来执行 SumUp API 的操作。
- 基于 Stdio 的传输协议: 使用标准输入输出 (stdio) 作为 MCP 服务器与客户端之间的通信协议。
安装步骤
- 确保已安装 Node.js 和 npm 或 yarn。
- 克隆或下载此 GitHub 仓库。
- 进入 'sumup-agent-toolkit' 仓库根目录。
- 确保安装了项目依赖,可以运行 'npm install' 或 'yarn install'。
- 设置 SumUp API 密钥环境变量 'SUMUP_API_KEY'。您需要在 SumUp 开发者平台获取 API 密钥。例如,在终端中执行 'export SUMUP_API_KEY=YOUR_SUMUP_API_KEY' (Linux/macOS) 或 'set SUMUP_API_KEY=YOUR_SUMUP_API_KEY' (Windows)。
服务器配置
MCP 客户端需要配置以下信息以连接到 SumUp MCP 服务器:
{ "serverName": "SumUp MCP Server", "command": "npx", "args": [ "-y", "@sumup/mcp" ], "transport": "stdio" }
- 'serverName': 服务器名称,可以自定义,例如 "SumUp MCP Server"。
- 'command': 启动服务器的命令,这里使用 'npx' 来运行 '@sumup/mcp' 包。
- 'args': 传递给 'npx' 命令的参数,'-y' 表示自动确认安装包,'@sumup/mcp' 是要执行的 MCP 服务器包。
- 'transport': 指定传输协议为 'stdio'。
基本使用方法
- 启动 SumUp MCP 服务器。在终端中,确保已设置 'SUMUP_API_KEY' 环境变量,然后导航到仓库根目录,运行命令 'SUMUP_API_KEY=YOUR_SUMUP_API_KEY npx -y @sumup/mcp'。服务器成功启动后,会输出 "✅ SumUp MCP Server running on stdio" 信息到 stderr。
- 配置并启动 MCP 客户端,将上述服务器配置信息填入 MCP 客户端的配置中。客户端会通过 stdio 与 MCP 服务器建立连接。
- 通过 MCP 客户端向 SumUp MCP 服务器发送请求,例如调用已注册的工具来检索交易信息或执行其他 SumUp API 操作。具体请求格式和操作方式请参考 MCP 客户端的文档和 SumUp Agent Toolkit 提供的工具列表。
信息
分类
商业系统