使用说明

项目简介

Stripe Agent Toolkit 是一个工具包,旨在通过函数调用将 Stripe API 集成到流行的 Agent 框架中,包括 LangChain、CrewAI、Vercel's AI SDK 和 Model Context Protocol (MCP)。它支持 Python 和 TypeScript,并提供了作为 MCP 服务器运行的能力。

主要功能点

  • Stripe API 工具化: 将 Stripe API 的常用功能(如创建客户、产品、价格、支付链接、发票、退款等)封装成一系列易于调用的工具。
  • MCP 服务器: 内置 Model Context Protocol (MCP) 服务器实现,可以通过标准 MCP 协议与 LLM 客户端通信,提供 Stripe 功能作为上下文服务。
  • 灵活配置: 允许配置允许使用的 Stripe API 功能,可以根据需要限制工具的访问权限。
  • 多框架集成: 除了 MCP,还支持与 LangChain, CrewAI, Vercel's AI SDK 等多种 Agent 框架集成,方便在不同场景下使用。
  • 支持关联账户: 可以配置 Stripe Connect 关联账户,代表关联账户进行 API 调用。

安装步骤

  1. 安装 Node.js 和 npm (如果使用 TypeScript 版本)Python 和 pip (如果使用 Python 版本)
  2. 安装 stripe-agent-toolkit 包:
    • TypeScript: 在你的项目目录中运行命令 'npm install @stripe/agent-toolkit'
    • Python: 在你的项目目录中运行命令 'pip install stripe-agent-toolkit' 如果需要修改源代码或运行本地 MCP 服务器,请先克隆 GitHub 仓库到本地。

服务器配置 (MCP 客户端配置)

以下 JSON 配置信息用于 MCP 客户端连接 Stripe MCP 服务器。请根据您的实际需求配置 'args' 参数。

{
  "serverName": "StripeMCP",
  "command": "npx",
  "args": [
    "-y",
    "@stripe/mcp",
    "--tools=all",  // 指定允许 LLM 调用的 Stripe 工具,可选值: 'all' (允许所有支持的工具) 或 逗号分隔的工具列表 (例如: 'customers.create,products.read')
    "--api-key=YOUR_STRIPE_SECRET_KEY" // 必须配置: 您的 Stripe Secret Key,请替换 'YOUR_STRIPE_SECRET_KEY' 为您的实际 Secret Key。 强烈建议将 Secret Key 安全地存储在环境变量中,而不是直接写在配置文件中。您也可以将 Stripe Secret Key 设置为环境变量 'STRIPE_SECRET_KEY',此时可以省略此参数。
    // "--stripe-account=acct_123" // 可选配置: Stripe Connect 关联账户 ID。 如果您的 LLM 需要代表关联账户操作 Stripe,请配置此参数,并替换 'acct_123' 为您的实际关联账户 ID。
  ]
}

基本使用方法

  1. 获取 Stripe Secret Key: 登录 Stripe Dashboard,在 API Keys 页面获取您的 Secret Key。
  2. 配置并启动 MCP 服务器:
    • 使用 npx 快速启动 (推荐): 在命令行中运行 'npx -y @stripe/mcp --tools=all --api-key=YOUR_STRIPE_SECRET_KEY' (请替换 'YOUR_STRIPE_SECRET_KEY' 为您的实际 Secret Key,并根据需要调整 '--tools' 参数)。
    • 自定义 MCP 服务器: 您可以参考仓库 README 中的 TypeScript 代码示例,自定义 MCP 服务器的启动方式和配置。
  3. 配置 MCP 客户端: 在您的 MCP 客户端应用中,配置上述 服务器配置 (MCP 客户端配置) JSON 信息,建立与 Stripe MCP 服务器的连接。
  4. 在 LLM 应用中使用 Stripe 工具: 通过 MCP 客户端向 Stripe MCP 服务器发送请求,LLM 即可调用 Stripe API 提供的各种工具,例如创建支付链接、查询客户信息等。 具体可参考仓库中提供的 LangChain, CrewAI, OpenAI 等框架的示例代码。

信息

分类

商业系统