使用说明内容(Markdown格式)

  • 项目简介

    • 该仓库实现了一个基于 MCP(Model Context Protocol)的后端服务器,用于为 MCP 客户端提供 Stripe 测试工具集合。通过标准的 MCP 机制,客户端可以读取、执行工具,以及渲染交互所需的提示模板。服务器通过 STDIO 通道与客户端通信,执行一组与 Stripe 测试环境相关的操作,如时钟时间仿真、创建/删除测试数据、以及创建测试订阅等。
  • 主要功能点

    • 时间仿真工具:创建并管理 Stripe 测试时钟,控制时间以测试时间敏感的工作流。
    • 客户管理工具:批量创建测试用户,支持关联测试时钟,方便进行时间相关的场景测试;支持批量删除。
    • 产品管理工具:归档或删除测试用的产品,保持测试数据清洁。
    • 订阅工具:为测试客户创建 Stripe 流水线订阅,支持设置 prorations 行为。
    • 安全与隔离:使用 Stripe 的测试模式,确保不会影响真实数据;禁止使用 live key。
    • 通信方式:通过 MCP 标准的 JSON-RPC 进行请求与响应,默认通过 STDIO 传输。
  • 安装步骤

    • 安装 Node.js 与 npm
    • 在项目目录下安装依赖并构建
    • 直接使用 npx stripe-test-mcp 启动服务器(按 README 指引,自动下载并运行最新版本的服务器)
  • 服务器配置

    • 说明:MCP 客户端需要提供一个配置,用于连接服务器。以下为符合仓库信息的示例配置要点,实际配置请以客户端实现为准。
    • server name: stripe-test-mcp
    • command: npx
    • args: stripe-test-mcp
    • 环境变量:
      • STRIPE_API_KEY: 你的 Stripe 测试模式 API Key(仅接受测试密钥,禁止使用 live/生产密钥)
    • 注释:该配置用于 Claude Desktop 等 MCP 客户端在启动时连接并访问该 MCP 服务器的工具集合。
  • 基本使用方法

    • 启动服务器(推荐通过 npx stripe-test-mcp)
    • 使用 MCP 客户端加载服务器配置,选择相应的工具进行调用,例如:
      • 创建 Stripe 测试时钟:传入 frozen_time(初始冻结时间的 Unix 时间戳)和可选的名称;
      • 创建测试客户:可指定数量、关联测试时钟等参数;
      • 创建测试订阅:提供客户 ID、订阅项以及可选的 prorations 行为;
      • 归档/删除产品或删除客户等操作均通过相应工具执行,结果以文本形式返回。
    • 注意事项:
      • 仅在 Stripe 的测试模式下进行操作;
      • 确保 STRIPE_API_KEY 设置正确且为测试密钥;
      • 某些操作可能有业务限制(如一个测试时钟最多关联 3 个客户),请在调用前了解工具的行为。

信息

分类

商业系统