使用说明
Payman API MCP服务器
MCP(模型上下文协议)服务器,与Payman AI的支付API无缝集成,允许AI助手通过自然语言创建收款人、搜索现有收款人、发送付款和检查余额。
概述
此MCP服务器将Payman AI的支付功能作为工具公开,可供Claude等LLM应用程序使用。它使AI助手能够执行以下操作:
- 设置用于身份验证的API密钥
- 创建不同类型的收款人(TEST_RAILS、US_ACH、CRYPTO_ADDRESS)
- 向已注册的收款人发送付款
- 根据各种条件搜索收款人
- 检查账户余额
此实现遵循模型上下文协议(MCP)标准,确保与任何兼容MCP的客户端兼容。
特性
- 安全的API身份验证:在会话中安全地管理API密钥
- 多种收款人类型:
- TEST_RAILS测试收款人
- 美国银行转账的US_ACH收款人
- 加密货币交易的CRYPTO_ADDRESS收款人
- 支付操作:
- 发送带有自定义金额和备忘录的付款
- 检索当前余额
- 搜索功能:
- 按姓名、联系信息、账户详细信息等搜索收款人。
- 错误处理:针对所有API操作的全面错误处理
- 安全运输:支持stdio和SSE(服务器发送事件)传输
先决条件
安装
通过Smithery安装
通过以下方式自动为Claude Desktop安装payman_mcp 史密瑟里:
npx -y @smithery/cli install @hrishi0102/payman_mcp --client claude
-
克隆存储库:
git clone https://github.com/yourusername/payman-mcp-server.git cd payman-mcp-server -
安装依赖项:
npm install # OR yarn install -
构建TypeScript代码:
npm run build # OR yarn build
配置
服务器不需要任何配置文件。API密钥在运行时使用 set-api-key 工具。
运行服务器
标准I/O模式(适用于克劳德桌面等)
在stdio模式下运行服务器,该模式与Claude Desktop和类似的MCP客户端兼容:
检查服务器是否设置正确:
node /ABSOLUTE/PATH/TO/PARENT/FOLDER/payman-mcp/build/payman-server.js
如果一切正常,您现在可以将Payman MCP服务器添加到任何客户端。
服务器发送事件(SSE)模式(用于web集成)
要使用SSE传输运行服务器(需要其他依赖关系: express 和 cors):
node build/payman-server-sse.js
这将在端口3001上启动一个具有以下端点的web服务器:
/sse-服务器到客户端通信的SSE端点/messages-客户端到服务器消息的端点
与MCP客户端集成
克劳德桌面
-
打开您的Claude Desktop配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 窗户:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
-
添加服务器配置:
{ "mcpServers": { "payman": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/payman-mcp-server/build/payman-server.js"] } } } -
重新启动克劳德桌面
其他MCP客户端
对于Cursor等其他MCP客户端,请参阅其添加MCP服务器的特定文档。
使用指南
一旦服务器连接到MCP客户端,您就可以使用以下工具:
设置API密钥
首先,您需要设置Payman API密钥:
Please use the set-api-key tool with my Payman API key: YOUR_API_KEY_HERE
创建收款人
测试轨道收款人
Create a test payee named "Test User" with the tag "test"
美国ACH收款人
Create a US ACH payee with these details:
- Name: John Doe
- Account Type: checking
- Account Number: 12345678
- Routing Number: 123456789
- Account Holder Name: John Doe
- Account Holder Type: individual
加密货币收款人
Create a crypto payee with:
- Name: Crypto Wallet
- Address: 0x1234567890abcdef
- Chain: ethereum
- Currency: ETH
发送付款
Send a payment of 100 to payee ID "pay_123abc" with the memo "Monthly service"
搜索收款人
Search for all payees with the name "John"
支票余额
What's my current balance?
工具参考
set-api-key
设置Payman API密钥以进行身份验证。
- 参数:
apiKey(字符串):Payman API密钥
create-test-rails-payee
创建用于测试的TEST_RAILS收款人。
- 参数:
name(string):收款人名称type(字符串):“TEST_RAILS”(默认)tags(string[]):收款人的可选标签
create-us-ach-payee
为银行转账创建US_ACH收款人。
- 参数:
type(字符串):“US_ACH”(默认)accountType(enum):“支票”或“储蓄”accountNumber(string):银行账号routingNumber(string):路由号accountHolderName(string):账户持有人的姓名accountHolderType(enum):“个人”或“企业”name(string):此收款人的名称- 加上其他可选参数(标签、联系人详细信息)
create-crypto-payee
为加密货币支付创建CRYPTO_ADDRESS收款人。
- 参数:
type(字符串):“CRYPTO_ADDRESS”(默认值)address(string):加密货币地址chain(string):要使用的区块链currency(string):加密货币/代币name(string):此收款人的名称- 加上其他可选参数(标签、联系人详细信息)
send-payment
向收款人发送付款。
- 参数:
payeeId(string):收款人IDamountDecimal(number):发送金额walletId(字符串,可选):要使用的特定钱包memo(字符串,可选):付款凭单metadata(对象,可选):其他元数据
search-payees
根据各种条件搜索收款人。
- 参数:多个可选搜索参数
name,contactEmail,accountNumber等等。
get-balance
检索当前账户余额。
- 参数:无
错误处理
所有工具都包括正确的错误处理,并在以下情况下返回描述性错误消息:
- 尚未设置API密钥
- API请求失败
- 提供的参数无效
- 出现网络问题