PayPal MCP Server

官方

PayPal 模型上下文协议服务器允许您通过函数调用与 PayPal API 集成。该协议支持多种工具，用于与不同的 PayPal 服务进行交互。

GitHub
187

文档

PayPal Agent 工具包

PayPal Agent 工具包使流行的代理框架（包括 OpenAI 的 Agent SDK、LangChain、Vercel 的 AI SDK 和模型上下文协议 (MCP)）能够通过函数调用与 PayPal API 集成。它支持 TypeScript，并基于 PayPal API 和 PayPal SDK 构建。

可用工具

PayPal Agent 工具包提供以下工具：

发票

  • 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：检索发货追踪信息
  • update_shipment_tracking：更新发货追踪信息

目录管理

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

订阅管理

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

报告与洞察

  • list_transactions：列出带有可选分页和筛选的交易
  • get_merchant_insights：检索商家的商业智能指标和分析数据

TypeScript

安装

除非您想修改此包，否则不需要此源代码。如果您只想使用该包，请运行：

npm install @paypal/agent-toolkit

要求

  • Node 18+

用法

该库需要使用您账户的客户端 ID 和密钥进行配置，这些信息可在您的 PayPal 开发者控制台 中找到。

该工具包可与 Vercel 的 AI SDK 配合使用，并可作为工具列表传递。有关更多详细信息，请参阅我们的 示例。

import { PayPalAgentToolkit } from '@paypal/agent-toolkit/ai-sdk';
const paypalToolkit = new PayPalAgentToolkit({
  clientId: process.env.PAYPAL_CLIENT_ID,
  clientSecret: process.env.PAYPAL_CLIENT_SECRET,
  configuration: {
    actions: {
      invoices: {
        create: true,
        list: true,
        send: true,
        sendReminder: true,
        cancel: true,
        generateQRC: true,
      },
      products: { create: true, list: true, update: true },
      subscriptionPlans: { create: true, list: true, show: true },
      shipment: { create: true, show: true, cancel: true },
      orders: { create: true, get: true },
      disputes: { list: true, get: true },
    },
  },
});

要使用沙盒模式，请在您的配置中添加上下文。

configuration: {
  context: {
    sandbox: true,
  }
}

初始化工作流

import { PayPalWorkflows, ALL_TOOLS_ENABLED } from '@paypal/agent-toolkit/ai-sdk';
const paypalWorkflows = new PayPalWorkflows({
  clientId: process.env.PAYPAL_CLIENT_ID,
  clientSecret: process.env.PAYPAL_CLIENT_SECRET,
  configuration: {
    actions: ALL_TOOLS_ENABLED,
  },
});

用法

使用工具包

const llm: LanguageModelV1 = getModel(); // The model to be used with ai-sdk
const { text: response } = await generateText({
  model: llm,
  tools: paypalToolkit.getTools(),
  maxSteps: 10,
  prompt: `Create an order for $50 for custom handcrafted item and get the payment link.`,
});

环境变量

可以使用以下环境变量：

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

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

前提条件

  • PayPal 开发者账户（用于沙盒）
  • PayPal 商业账户（用于生产）

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

  1. 创建 PayPal 开发者账户：

  2. 访问您的凭据：

    • 在开发者控制台中，点击菜单中的 应用与凭据
    • 根据您的需求在 沙盒 和 正式 模式之间切换

  3. 创建或查看应用：

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

  4. 获取凭据：

    • 创建或选择应用后，您将看到一个包含以下信息的屏幕：
      • 客户端 ID：应用的公共标识符
      • 客户端密钥：私钥（点击“显示”后可见）
    • 请安全保存这些凭据，因为生成访问令牌时需要它们

生成访问令牌

使用 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. 在 授权 下，选择 基础认证 并输入您的客户端 ID 和客户端密钥
  4. 在 正文 下，选择 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. 避免在应用程序代码中硬编码令牌

免责声明

AI 生成的内容可能不准确或不完整。用户在依赖任何信息之前，有责任独立验证其准确性。PayPal 不对输出的准确性作任何保证，也不对因使用该内容而产生的任何决定、行动或后果承担责任。