项目简介

Cashfree MCP 服务端是一个基于 Model Context Protocol (MCP) 构建的应用后端。它允许 AI 工具和代理（如大语言模型客户端）通过标准化的方式访问 Cashfree 的各种 API，包括支付网关 (Payment Gateway)、提现 (Payouts) 和身份验证 (SecureID)。

主要功能点

• API 集成: 将 Cashfree 的支付、提现和身份验证功能通过定义好的工具暴露给 AI 代理。
• 工具注册: 注册一系列可由 AI 调用的工具，例如创建支付链接、查询订单状态、发起提现、验证身份信息等。
• 文档搜索: 提供搜索 Cashfree 开发者文档的能力，为 AI 提供相关的上下文信息。
• 会话管理: 管理与客户端的连接和交互会话。
• 环境配置: 支持配置 Cashfree 的沙箱或生产环境，以及相应的 API 凭据。
• 模块化: 可选择启用不同的 Cashfree 产品模块（支付、提现、身份验证）。

安装步骤

1. 克隆仓库：

   git clone https://github.com/cashfree/cashfree-mcp.git
   cd cashfree-mcp
   

2. 安装依赖：

   npm install
   

   （需要 Node.js 14.x 或更高版本）

服务器配置

本 MCP 服务器通常由 MCP 客户端（如特定的 IDE 插件、桌面应用或框架）负责启动和连接。您需要在您的 MCP 客户端配置中指定如何启动这个服务器进程，并提供必要的 Cashfree API 凭据。

典型的客户端配置会包含一个服务端的定义块，其中指定：

• 'command': 启动服务器的可执行命令，例如 'node'。
• 'args': 传递给命令的参数，指向服务器的入口文件，例如 '/path/to/cashfree-mcp/src/index.js'。
• 'env': 设置服务器运行所需的环境变量，主要用于配置 Cashfree API 密钥和行为：
  • 'PAYMENTS_APP_ID', 'PAYMENTS_APP_SECRET': Cashfree 支付网关的 API 凭据。
  • 'PAYOUTS_APP_ID', 'PAYOUTS_APP_SECRET': Cashfree 提现的 API 凭据。
  • 'SECUREID_APP_ID', 'SECUREID_APP_SECRET': Cashfree SecureID 的 API 凭据。
  • 'TWO_FA_PUBLIC_KEY_PEM_PATH': （如果启用双因素认证）指向 2FA 公钥文件路径。
  • 'ENV': 指定运行环境，'sandbox' (沙箱) 或 'production' (生产)。
  • 'TOOLS': 逗号分隔的字符串，指定要启用的工具模块（'pg' 表示支付，'payouts' 表示提现，'secureid' 表示身份验证）。

请参考您的 MCP 客户端的文档，将上述信息填入其 MCP 服务器配置界面或文件。

基本使用方法

配置完成后，当您的 MCP 客户端（如支持 MCP 的 AI 助手）连接到此服务器时，它将能够发现并调用服务器暴露的工具。

您可以通过自然语言指示 AI 执行 Cashfree 相关的操作，例如：

• "创建一个金额为 100 元、订单号为 ord_123 的支付链接。" (调用 'create-payment-link' 工具)
• "查询订单号 ord_456 的当前状态。" (调用 'get-order' 工具)
• "向银行账户 XXX 发起一笔金额为 500 元的提现。" (调用 'standard-transfer-v2' 工具)
• "验证用户名为 John Doe 是否匹配提供的身份信息。" (调用 'verify-name-match' 工具)
• "搜索关于 Cashfree 退款 API 的文档。" (调用 'search' 工具)

AI 客户端会负责理解您的意图，并将其转换为对相应工具的调用请求，然后将结果呈现给您。