README
🚀 Paddle 账单 MCP 服务器
Paddle 账单是面向开发者的持牌商家,通过统一的 API 处理付款、税收、订阅和指标等事务。本项目是一个模型上下文协议 (MCP) 服务器,提供与 Paddle API 交互的工具。
🚀 快速开始
Paddle 账单是面向开发者的持牌商家,可通过统一的 API 处理付款、税收、订阅和指标等事务。本项目是一个模型上下文协议 (MCP) 服务器,提供与 Paddle API 交互的工具。
⚠️ 重要提示
此 MCP 服务器适用于 Paddle 账单,不支持 Paddle 经典版本。如需使用 Paddle 经典版本,请参阅:Paddle 经典 API 参考
✨ 主要特性
- 列出您 Paddle 产品目录中的商品
- 创建新商品
- 列出商品的价格
- 为商品创建新的价格
- 列出客户
- 列出交易
- 列出订阅
- 创建自定义报告以进行财务分析
📦 安装指南
要使用 MCP 服务器,您需要一个 API 密钥。您可以在 Paddle > 开发工具 > 认证 中创建和管理 API 密钥:
- 沙盒环境: https://sandbox-vendors.paddle.com/authentication-v2
- 生产环境: https://vendors.paddle.com/authentication-v2
您可以使用 npx 运行 Paddle MCP 服务器,命令如下:
npx -y @paddle/paddle-mcp --api-key=PADDLE_API_KEY --environment=(sandbox|production)
将 PADDLE_API_KEY 替换为您的 API 密钥,并传递正确的值作为 environment。
要在 Claude Desktop、Cursor 或 Windsurf 等客户端中运行服务器,请在 MCP 配置中添加以下内容:
{
"mcpServers": {
"paddle": {
"command": "npx",
"args": ["-y", "@paddle/paddle-mcp", "--api-key=PADDLE_API_KEY", "--environment=(sandbox|production)"]
}
}
}
有关详细安装指南,请参阅:
💻 使用示例
基础用法
在客户端配置中使用 npx 运行 Paddle MCP 服务器:
npx -y @paddle/paddle-mcp --api-key=PADDLE_API_KEY --environment=(sandbox|production)
高级用法
在 Claude Desktop、Cursor 或 Windsurf 等客户端的 MCP 配置中添加服务器信息:
{
"mcpServers": {
"paddle": {
"command": "npx",
"args": ["-y", "@paddle/paddle-mcp", "--api-key=PADDLE_API_KEY", "--environment=(sandbox|production)"]
}
}
}
📚 详细文档
开发步骤
- 安装依赖项:
pnpm install
- 构建服务器:
pnpm build
- 更新客户端以使用本地构建:
{
"mcpServers": {
"paddle": {
"command": "node",
"args": ["path/to/paddle-mcp-server/build/index.js"],
"env": {
"PADDLE_API_KEY": "your_api_key",
"PADDLE_ENVIRONMENT": "sandbox"
}
}
}
}
调试方法
要调试 MCP 服务器,可以使用 MCP 检查工具:
- 使用检查工具运行服务器:
pnpm inspector
- 在浏览器中打开提供的 URL 以查看和调试 MCP 请求和响应。
- 包括
--api-key和--environment参数。
Scan to contact