MCP Server for Paddle Billing

Paddle Billing 的 MCP 服务

Paddle Billing 是以开发者为先的名义商户。我们通过一个统一的 API 处理支付、税费、订阅和指标。

这是一个 Model Context Protocol (MCP) 服务，为大模型和 AI Agent 提供与 Paddle API 交互的工具。

重要： 此 MCP 服务适用于 Paddle Billing，不支持 Paddle Classic。如需使用 Paddle Classic，请参阅：Paddle Classic API 参考

功能

此 MCP 服务与 Paddle API 的功能几乎完全一致，可让 AI 助手和 Agent：

• 管理完整的 Paddle 商品目录
• 查看客户、购买和开通信息
• 处理订阅、支付和退款工作流
• 调试计费和订单管理问题
• 直接在对话中创建和调整交易
• 生成财务报告，以深入了解财务和运营情况
• 更快地实现和测试 Paddle 集成

可用工具

MCP 服务可使用以下工具对你的 Paddle 账户执行操作：

商品

操作	工具	非破坏性	只读
列出商品	list_products	✅	✅
创建商品	create_product	✅	❌
获取商品	get_product	✅	✅
更新商品	update_product	❌	❌

价格

操作	工具	非破坏性	只读
列出价格	list_prices	✅	✅
创建价格	create_price	✅	❌
获取价格	get_price	✅	✅
更新价格	update_price	❌	❌
预览价格	preview_prices	✅	❌

折扣

操作	工具	非破坏性	只读
列出折扣	list_discounts	✅	✅
创建折扣	create_discount	✅	❌
获取折扣	get_discount	✅	✅
更新折扣	update_discount	❌	❌

折扣组

操作	工具	非破坏性	只读
列出折扣组	list_discount_groups	✅	✅
创建折扣组	create_discount_group	✅	❌
获取折扣组	get_discount_group	✅	✅
更新折扣组	update_discount_group	❌	❌
归档折扣组	archive_discount_group	❌	❌

客户

| 操作 | 工具 | 非破坏性 | 只读 | |-----------|------|-----------------|-----------| | 列出客户 | `list_customers` | ✅ | ✅ | | 创建客户 | `create_customer` | ✅ | ❌ | | 获取客户 | `get_customer` | ✅ | ✅ | | 更新客户 | `update_customer` | ❌ | ❌ | | 列出客户的信用余额 | `list_credit_balances` | ✅ | ✅ |

地址

操作	工具	非破坏性	只读
列出客户的地址	list_addresses	✅	✅
为客户创建地址	create_address	✅	❌
获取客户的地址	get_address	✅	✅
更新客户的地址	update_address	❌	❌

企业

操作	工具	非破坏性	只读
列出客户的企业	list_businesses	✅	✅
为客户创建企业	create_business	✅	❌
获取客户的企业	get_business	✅	✅
更新客户的企业	update_business	❌	❌

交易

操作	工具	非破坏性	只读
列出交易	list_transactions	✅	✅
创建交易	create_transaction	✅	❌
获取交易	get_transaction	✅	✅
更新交易	update_transaction	❌	❌
预览交易	preview_transaction_create	✅	❌
修改已开票或已完成交易中的客户信息	revise_transaction	❌	❌
获取交易的 PDF 发票	get_transaction_invoice	✅	✅

调整

操作	工具	非破坏性	只读
列出调整	list_adjustments	✅	✅
创建调整	create_adjustment	✅	❌
获取调整的 PDF 贷项通知单	get_adjustment_credit_note	✅	✅

订阅

操作	工具	非破坏性	只读
列出订阅	list_subscriptions	✅	✅
获取订阅	get_subscription	✅	✅
更新订阅	update_subscription	❌	❌
取消订阅	cancel_subscription	❌	❌
暂停订阅	pause_subscription	❌	❌
恢复已暂停的订阅	resume_subscription	❌	❌
激活试用中的订阅	activate_subscription	❌	❌
预览订阅更新	preview_subscription_update	✅	❌
为订阅创建一次性收费	create_subscription_charge	✅	❌
预览订阅的一次性收费	preview_subscription_charge	✅	❌

已保存的支付方式

操作	工具	非破坏性	只读
列出为客户保存的支付方式	list_saved_payment_methods	✅	✅
获取为客户保存的支付方式	get_saved_payment_method	✅	✅
删除为客户保存的支付方式	delete_saved_payment_method	❌	❌

客户门户会话

操作	工具	非破坏性	只读
创建客户门户会话	create_customer_portal_session	✅	❌

通知设置

| 操作 | 工具 | 非破坏性 | 只读 | |-----------|------|-----------------|-----------| | 列出通知设置 | `list_notification_settings` | ✅ | ✅ | | 创建通知设置 | `create_notification_setting` | ✅ | ❌ | | 获取通知设置 | `get_notification_setting` | ✅ | ✅ | | 更新通知设置 | `update_notification_setting` | ❌ | ❌ | | 删除通知设置 | `delete_notification_setting` | ❌ | ❌ |

事件

操作	工具	非破坏性	只读
列出事件	list_events	✅	✅

通知

操作	工具	非破坏性	只读
列出通知	list_notifications	✅	✅
获取通知	get_notification	✅	✅
重放通知	replay_notification	✅	❌

通知日志

操作	工具	非破坏性	只读
列出通知日志	list_notification_logs	✅	✅

模拟

操作	工具	非破坏性	只读
列出模拟	list_simulations	✅	✅
创建模拟	create_simulation	✅	❌
获取模拟	get_simulation	✅	✅
更新模拟	update_simulation	❌	❌

模拟运行

操作	工具	非破坏性	只读
列出模拟的运行记录	list_simulation_runs	✅	✅
为模拟创建运行记录	create_simulation_run	✅	❌
获取模拟的运行记录	get_simulation_run	✅	✅

模拟运行事件

操作	工具	非破坏性	只读
列出模拟运行的事件	list_simulation_run_events	✅	✅
获取模拟运行的事件	get_simulation_run_event	✅	✅
重放模拟运行的事件	replay_simulation_run_event	✅	❌

报告

操作	工具	非破坏性	只读
列出报告	list_reports	✅	✅
创建报告	create_report	✅	❌
获取报告	get_report	✅	✅
获取报告的 CSV 文件	get_report_csv	✅	✅

客户端令牌

操作	工具	非破坏性	只读
列出客户端令牌	list_client_side_tokens	✅	✅
创建客户端令牌	create_client_side_token	✅	❌
获取客户端令牌	get_client_side_token	✅	✅
撤销客户端令牌	revoke_client_side_token	❌	❌

安装

要使用 MCP 服务，你需要一个 API 密钥。你可以在 Paddle > Developer tools > Authentication 中创建和管理 API 密钥：

• Sandbox：https://sandbox-vendors.paddle.com/authentication-v2
• Live：https://vendors.paddle.com/authentication-v2

将以下内容添加到 MCP 设置文件中，即可在 Claude Desktop、Cursor 或 Windsurf 等客户端中配置并运行 Paddle MCP 服务：

方法 1：在 Cursor 或 VS Code 中一键安装

你可以在 Cursor 或 VS Code 中一键安装 Paddle MCP 服务。

安装后，你需要在 MCP 设置文件中更新配置，将 your_api_key 替换为你的实际 Paddle API 密钥，并根据需要调整环境和工具值。

方法 2：使用命令行参数（推荐用于 npx）

将以下内容添加到所用客户端的 MCP 设置或配置文件中：

{
  "mcpServers": {
    "paddle": {
      "command": "npx",
      "args": [
        "-y",
        "@paddle/paddle-mcp",
        "--api-key=your_api_key",
        "--environment=sandbox",
        "--tools=non-destructive"
      ]
    }
  }
}

将 your_api_key 替换为你的实际 Paddle API 密钥，将 --environment 设置为 sandbox 或 production，并将 --tools 设置为要加载并提供给 MCP 客户端使用的工具。

方法 3：使用环境变量

将以下内容添加到所用客户端的 MCP 设置或配置文件中：

{
  "mcpServers": {
    "paddle": {
      "command": "npx",
      "args": ["-y", "@paddle/paddle-mcp"],
      "env": {
        "PADDLE_API_KEY": "your_api_key",
        "PADDLE_ENVIRONMENT": "sandbox",
        "PADDLE_MCP_TOOLS": "non-destructive"
      }
    }
  }
}

将 your_api_key 替换为你的实际 Paddle API 密钥，将 PADDLE_ENVIRONMENT 设置为 sandbox 或 production，并将 PADDLE_MCP_TOOLS 设置为要加载并提供给 MCP 客户端使用的工具。

筛选工具

你可以通过传入 --tools 参数（方法 2）或设置 PADDLE_MCP_TOOLS 环境变量（方法 1 或 3），筛选要加载并提供给 MCP 客户端使用的工具。可接受的值包括：

• all - 提供所有工具
• read-only - 仅提供读取操作
• non-destructive - 提供读取操作和安全的写入操作（默认）
• 以逗号分隔的特定工具名称列表（例如：list_products,get_product,create_product）

如需详细的设置指南，请参阅：

• Claude Desktop
• Cursor
• Windsurf

开发

1. 安装依赖项：

   pnpm install
   

2. 构建服务：

   pnpm build
   

3. 更新客户端以使用本地构建版本：

   {
     "mcpServers": {
       "paddle": {
         "command": "node",
         "args": ["path/to/paddle-mcp-server/build/index.js"],
         "env": {
           "PADDLE_API_KEY": "your_api_key",
           "PADDLE_ENVIRONMENT": "sandbox",
           "PADDLE_MCP_TOOLS": "all"
         }
       }
     }
   }
   

   PADDLE_MCP_TOOLS 环境变量接受与 --tools 参数相同的值：all、read-only、non-destructive 或以逗号分隔的工具名称列表。如果未设置，默认值为 non-destructive。

调试

你可以使用 MCP Inspector 工具调试 MCP 服务：

1. 使用 Inspector 运行服务：

   pnpm inspector
   

2. 在浏览器中打开提供的 URL，查看并调试 MCP 请求和响应。

3. 包含 --api-key 和 --environment 参数。

了解更多

• Paddle 开发者文档
• Paddle API 参考
• 注册 Paddle Billing