MCP支付系统示例项目简介

本项目 'mcp-payment-example' 是一个基于 Model Context Protocol (MCP) 构建的支付系统后端示例,旨在演示如何使用 MCP 框架将你的应用数据和功能与 AI 模型无缝集成。

你可以通过两种方式使用这个项目:

  1. 交互式开发与测试:使用 MCP Inspector 工具直接与支付系统进行交互和测试。
  2. AI 集成:将支付系统连接到 AI 模型(如 Claude),实现自动化的支付处理流程。

主要功能点

  • 资源 (Resources)

    • 货币汇率 (Currency Exchange Rates):提供实时的货币汇率数据,支持以 JSON 或文本格式获取。
  • 工具 (Tools)

    • 支付总结 (Payment Summary):获取用户的支付汇总信息,可按不同货币和时间范围进行查询。
    • 添加支付 (Add Payment):创建新的支付交易,支持多币种和详细描述。
    • 欺诈检查 (Fraud Check):检测潜在的欺诈交易,提供基础和详细两种报告级别。
    • 支付详情 (Payment Details):根据支付状态筛选并查看支付详细信息 (仅基础版本)。
    • 欺诈警报 (Fraud Alert):检查并报告用户的欺诈警报 (仅基础版本)。
  • Prompt 模板 (Prompts)

    • 生成报告 (Generate Report):生成各种格式(如 Markdown)的支付报告,用于数据分析和展示。

安装步骤

  1. 克隆仓库

    git clone https://github.com/jagreehal/mcp-payment-example
    cd mcp-payment-example
  2. 安装依赖: 确保你已安装 Bun 或 Node.js v18+ 环境。然后运行:

    bun install

服务器配置 (MCP客户端)

要将此 MCP 服务器集成到 MCP 客户端(如 Claude),你需要配置客户端的 'claude_desktop_config.json' 文件。以下是配置示例,你需要根据你的实际项目路径进行调整。

{
  "mcpServers": {
    "payments-basic": {
      "command": "bun",
      "args": ["run", "/path/to/mcp-payment-example/src/basic.ts"]
    },
    "payments-enhanced": {
      "command": "bun",
      "args": ["run", "/path/to/mcp-payment-example/src/enhanced.ts"]
    }
  }
}

配置参数说明

  • '"mcpServers"': 定义 MCP 服务器配置的对象。
  • '"payments-basic"' 和 '"payments-enhanced"': 服务器名称,可以自定义,用于在客户端中引用。
  • '"command"': 启动服务器的命令,通常为 '"bun"' 或 '"node"'。
  • '"args"': 命令参数数组,包括 '"run"' 和服务器脚本的绝对路径
    • 请将 '/path/to/mcp-payment-example' 替换为你克隆仓库的实际绝对路径。 你可以在终端中进入项目目录后运行 'pwd' 命令获取当前目录的绝对路径。

注意

  • 请确保在 'args' 中使用服务器脚本的绝对路径
  • 配置文件中请移除注释。

基本使用方法

1. 启动服务器

你可以选择启动基础版本 ('basic.ts') 或增强版本 ('enhanced.ts') 服务器。

开发模式 (推荐,使用 MCP Inspector)

打开终端,运行以下命令启动服务器并连接到 MCP Inspector:

npx @modelcontextprotocol/inspector bun src/basic.ts      # 基础版本
npx @modelcontextprotocol/inspector bun src/enhanced.ts   # 增强版本

MCP Inspector 是一个用于测试和调试 MCP 服务器的工具,它会打开一个交互界面,你可以直接在 Inspector 中调用服务器提供的工具和资源。

生产模式

如果你不需要 MCP Inspector,可以直接运行服务器:

bun run start:basic     # 基础版本
bun run start:enhanced  # 增强版本

2. 使用 MCP Inspector (开发模式)

启动 Inspector 后,你将在界面中看到服务器注册的工具 (Tools) 和资源 (Resources)。

  • 调用工具 (Tools):在 Inspector 中选择 "Tools" 选项卡,找到你想调用的工具(例如 "paymentSummary"),输入必要的参数(例如 'userId: "U123"'),然后点击 "Execute" 按钮。服务器将处理请求并返回结果。

  • 访问资源 (Resources):在 Inspector 中选择 "Resources" 选项卡,展开 "currencyRates" 资源,你可以看到可用的资源 URI,例如 'currency://rates/json'。点击 URI 可以查看资源的内容(货币汇率 JSON 数据)。

3. AI 集成 (生产模式)

在生产模式下,你需要将服务器配置添加到 MCP 客户端(如 Claude),客户端将能够发现并调用服务器提供的工具和资源。具体的集成方式请参考 MCP 客户端的文档。

示例工具调用 (通过自然语言指令)

以下是一些可以通过自然语言指令触发的工具调用示例 (以基础版本为例):

  • 获取支付总结: 'Show payment summary for user U123'
  • 查看待处理状态的支付: 'Show payments with status pending'
  • 检查用户 U123 的欺诈警报: 'Check for fraud alerts for user U123'

示例资源访问 (通过自然语言指令)

  • 获取当前汇率: 'Get current exchange rates' (客户端需要支持资源访问功能)

请根据你的需求选择基础版本或增强版本,并参考仓库中的 README.md 文件获取更详细的信息和高级用法。

信息

分类

商业系统