paypal-mcp-server

PayPal Model Context Protocol

PayPal Model Context Protocol 服务支持通过函数调用集成 PayPal API。此协议提供多种工具，可与不同的 PayPal 服务交互。

使用 npx 运行 PayPal MCP 服务，请使用以下命令：

npx -y @paypal/mcp --tools=all PAYPAL_ACCESS_TOKEN="YOUR_ACCESS_TOKEN" PAYPAL_ENVIRONMENT="SANDBOX"

将 YOUR_ACCESS_TOKEN 替换为你的 PayPal 访问令牌。请参阅此处了解如何生成 PayPal 访问令牌。或者，你也可以在环境变量中设置 PAYPAL_ACCESS_TOKEN。

在 MCP 主机（Claude Desktop/Cline/Cursor/GitHub Copilot）中使用

本指南介绍如何将 PayPal 连接器集成到 Claude Desktop 中。

前提条件

• 已安装 Claude Desktop 应用程序
• 在本地安装 Node.js

安装步骤

1. 安装 Node.js

PayPal 连接器需要 Node.js 才能正常运行：

1. 访问 Node.js 官方网站，下载并安装。
2. 要求：Node 18+

2. 在 MCP 主机（Claude desktop / Cursor / Cline）中配置 PayPal 连接器

下面将介绍如何与 Claude desktop 集成。你也可以使用自己喜欢的 MCP 主机。

1. 打开 Claude Desktop
2. 前往 Settings
3. 找到 Developer 或 Advanced 设置部分
4. 找到外部工具或连接器配置区域
5. 将以下 PayPal 连接器配置添加到此文件 ~/Claude/claude_desktop_config.json：

{
   "mcpServers": {
     "paypal": {
       "command": "npx",
       "args": [
         "-y",
         "@paypal/mcp",
         "--tools=all"
       ],
       "env": {
         "PAYPAL_ACCESS_TOKEN": "YOUR_PAYPAL_ACCESS_TOKEN",
         "PAYPAL_ENVIRONMENT": "SANDBOX"
       }
     }
   }
}

请务必将 YOUR_PAYPAL_ACCESS_TOKEN 替换为你的实际 PayPal 访问令牌。或者，你也可以将 PAYPAL_ACCESS_TOKEN 设置为环境变量。你还可以使用 --access-token 将其作为参数传入 "args" 将 PAYPAL_ENVIRONMENT 的值设为 SANDBOX，用于阶段测试；或设为 PRODUCTION，用于生产环境。

6. 保存配置更改

3. 测试集成

1. 退出并重启 Claude Desktop，以应用更改
2. 让 Claude 执行与 PayPal 相关的任务，以测试连接
   • 示例："列出我的 PayPal 发票"

可用工具

发票

• create_invoice：在 PayPal 系统中创建新发票
• list_invoices：列出发票，可选择分页和筛选
• get_invoice：检索特定发票的详细信息
• send_invoice：向收件人发送发票
• send_invoice_reminder：发送现有发票的提醒
• cancel_sent_invoice：取消已发送的发票
• generate_invoice_qr_code：为发票生成二维码

付款

• create_order：根据提供的详细信息在 PayPal 系统中创建订单
• get_order：检索订单的详细信息
• pay_order：处理已授权订单的付款
• create_refund：处理已捕获付款的退款。
• get_refund：获取特定退款的详细信息。

争议管理

• list_disputes：检索所有未结争议的摘要
• get_dispute：检索特定争议的详细信息
• accept_dispute_claim：接受争议索赔

货件追踪

• create_shipment_tracking：创建货件追踪记录
• get_shipment_tracking：检索货件追踪信息

目录管理

• create_product：在 PayPal 目录中创建新产品
• list_products：列出产品，可选择分页和筛选
• show_product_details：检索特定产品的详细信息
• update_product：更新现有产品

订阅管理

• create_subscription_plan：创建新的订阅计划
• update_plan：更新现有计划
• list_subscription_plans：列出订阅计划
• show_subscription_plan_details：检索特定订阅计划的详细信息
• create_subscription：创建新订阅
• show_subscription_details：检索特定订阅的详细信息
• update_subscription：更新现有订阅
• cancel_subscription：取消有效订阅

报告与洞察

• list_transactions：列出交易，可选择分页和筛选

环境变量

可使用以下环境变量：

• PAYPAL_ACCESS_TOKEN：您的 PayPal 访问令牌
• PAYPAL_ENVIRONMENT：沙盒模式设为 SANDBOX，生产环境设为 PRODUCTION（默认为 SANDBOX 模式）

本指南介绍如何为 PayPal API 集成生成访问令牌，包括如何查找您的客户端 ID 和客户端密钥。

前提条件

• PayPal Developer 账户（用于 Sandbox）
• PayPal Business 账户（用于生产环境）

查找您的客户端 ID 和客户端密钥

1. 创建 PayPal Developer 账户：

   • 前往 PayPal Developer Dashboard
   • 使用您的 PayPal 凭据注册或登录

2. 访问您的凭据：

   • 在 Developer Dashboard 中，点击菜单里的 Apps & Credentials
   • 根据需要在 Sandbox 和 Live 模式之间切换

3. 创建或查看应用：

   • 要创建新应用，请点击 Create App
   • 为应用命名，并选择一个与之关联的 Business 账户
   • 对于现有应用，点击应用名称以查看详细信息

4. 获取凭据：

   • 创建或选择应用后，您会看到一个页面，其中显示：
     • Client ID：应用的公开标识符
     • Client Secret：私钥（点击 "Show" 后显示）
   • 请妥善保存这些凭据，因为生成访问令牌时需要使用

生成访问令牌

使用 cURL

curl -v https://api-m.sandbox.paypal.com/v1/oauth2/token \\
  -H \"Accept: application/json\" \\
  -H \"Accept-Language: en_US\" \\
  -u \"CLIENT_ID:CLIENT_SECRET\" \\
  -d \"grant_type=client_credentials\"

将 CLIENT_ID 和 CLIENT_SECRET 替换为您的实际凭据。生产环境请使用 https://api-m.paypal.com，而不是沙盒 URL。

使用 Postman

1. 创建一个新请求，访问 https://api-m.sandbox.paypal.com/v1/oauth2/token
2. 将方法设为 POST
3. 在 Authorization 下，选择 Basic Auth 并输入您的 Client ID 和 Client Secret
4. 在 Body 下，选择 x-www-form-urlencoded，添加键 grant_type，值为 client_credentials
5. 发送请求

响应

成功的响应如下所示：

{
  "scope": "...",
  "access_token": "Your Access Token",
  "token_type": "Bearer",
  "app_id": "APP-80W284485P519543T",
  "expires_in": 32400,
  "nonce": "..."
}

复制 access_token 值，以便在 Claude Desktop 集成中使用。

令牌详情

• 沙盒令牌：有效期为 3-8 小时
• 生产令牌：有效期为 8 小时
• 建议在令牌过期前实现令牌刷新逻辑

在 Claude Desktop 中使用令牌

获取访问令牌后，请在 Claude Desktop 连接器配置中更新 PAYPAL_ACCESS_TOKEN 的值：

{
  "env": {
    "PAYPAL_ACCESS_TOKEN": "YOUR_NEW_ACCESS_TOKEN",
    "PAYPAL_ENVIRONMENT": "SANDBOX"
  }
}

最佳实践

1. 安全存储客户端 ID 和客户端密钥
2. 实现令牌刷新逻辑，以处理令牌过期
3. 使用特定环境的令牌（测试时使用沙盒令牌，真实交易时使用生产令牌）
4. 避免在应用程序代码中硬编码令牌

免责声明

@paypal/mcp 提供对 AI 生成内容的访问，这些内容可能不准确或不完整。用户有责任在依赖任何信息之前独立核实。PayPal 不保证输出内容的准确性，也不对因使用这些内容而导致的任何决定、行为或后果承担责任。