使用说明

项目简介

Paddle MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它作为 LLM（大型语言模型）客户端和 Paddle Billing API 之间的桥梁。通过 MCP 协议，该服务器允许 LLM 客户端调用预定义的工具，从而安全、便捷地访问和操作 Paddle Billing 的各项功能，例如查询产品目录、创建新产品、管理价格、检索客户信息以及生成财务报表等。这使得开发者能够构建基于 LLM 的应用，无缝集成 Paddle Billing 的强大支付和订阅管理能力。

主要功能点

产品管理:
- 列出产品目录中的所有产品
- 创建新的产品
价格管理:
- 列出产品的价格信息
- 为产品创建新的价格
客户管理:
- 列出客户信息
交易管理:
- 列出交易记录
订阅管理:
- 列出订阅信息
报表生成:
- 创建自定义报表，用于财务分析

安装步骤

安装 Node.js 和 npm (或 pnpm): 确保你的开发环境中已安装 Node.js 和 npm 包管理器。如果使用 pnpm，请先全局安装 pnpm ('npm install -g pnpm')。
获取 Paddle API 密钥: 你需要一个 Paddle API 密钥才能连接到你的 Paddle 账户。
- Sandbox 环境: 访问 https://sandbox-vendors.paddle.com/authentication-v2 获取 Sandbox API 密钥。
- Live 环境: 访问 https://vendors.paddle.com/authentication-v2 获取 Live API 密钥。

使用 npx 运行 (推荐): 这是最简单快捷的运行方式，无需本地安装。在终端中执行以下命令，替换 'PADDLE_API_KEY' 为你的 API 密钥，并选择 'sandbox' 或 'production' 环境：

npx -y @paddle/paddle-mcp --api-key=PADDLE_API_KEY --environment=(sandbox|production)

服务器配置

为了让 MCP 客户端（如 Claude Desktop, Cursor, Windsurf）连接到 Paddle MCP Server，你需要在客户端的 MCP 配置中添加以下 JSON 配置。请根据你选择的环境 (sandbox 或 production) 替换 'PADDLE_API_KEY' 和 'environment' 的值。

{
  "mcpServers": {
    "paddle": {
      "command": "npx",
      "args": [
        "-y",
        "@paddle/paddle-mcp",
        "--api-key=PADDLE_API_KEY",  // 替换为你的 Paddle API 密钥
        "--environment=(sandbox|production)" //  替换为 "sandbox" 或 "production"
      ]
    }
  }
}

'server name': 'paddle' (用于在客户端中标识该服务器)
'command': 'npx' (用于执行 npm 包的命令)
'args': 启动服务器的参数列表
- '-y': 'npx' 参数，自动确认安装包
- '@paddle/paddle-mcp': 要执行的 npm 包，即 Paddle MCP Server
- '--api-key=PADDLE_API_KEY': Paddle API 密钥，请替换为你的实际 API 密钥
- '--environment=(sandbox|production)': Paddle 环境，请替换为 'sandbox' 或 'production'

基本使用方法

启动 Paddle MCP Server: 按照上述“安装步骤”中的 npx 命令或开发模式启动服务器。
配置 MCP 客户端: 将上述 “服务器配置” 中的 JSON 配置添加到你的 MCP 客户端（如 Claude Desktop, Cursor, Windsurf）的 MCP 配置中。确保 API 密钥和环境配置正确。
在 LLM 客户端中使用工具: 在支持 MCP 协议的 LLM 客户端中，你可以通过自然语言指令调用 Paddle MCP Server 提供的工具。例如，你可以询问 "列出所有产品" 或 "创建一个名为 '高级版' 的新产品"。客户端会将你的指令转换为 MCP 请求发送到 Paddle MCP Server，服务器执行相应的 Paddle API 调用并将结果返回给客户端。

注意: 请务必妥善保管你的 Paddle API 密钥，避免泄露。在生产环境中使用时，请考虑更安全的密钥管理方式，例如使用环境变量或密钥管理服务。

关键词

使用说明

信息