PayPal Agent Toolkit

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

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
});

const llm: LanguageModelV1 = getModel(); // The model to be used with ai-sdk
const {text: response}= await generateText({
    model: llm,
    tools: await paypalToolkit.getTools(),
    prompt: `Create an invoice for 3 hours of labor at $120/hr and text a link to John Doe.`,
});

PayPal 模型上下文协议

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

运行 MCP Inspector

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

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

将 YOUR_ACCESS_TOKEN 替换为使用以下步骤生成的有效访问令牌：PayPal 访问令牌。或者，您可以在环境变量中设置 PAYPAL_ACCESS_TOKEN。

自定义 MCP 服务器

您可以设置自己的 MCP 服务器。例如：

import { PayPalAgentToolkit } from “@paypal/agent-toolkit/modelcontextprotocol";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";

const tools = payPalAgentToolkit.getTools();

const server = new PayPalAgentToolkit({
	accessToken: process.env.PAYPAL_ACCESS_TOKEN
});

async function main() {
  const transport = new StdioServerTransport();
  await server.connect(transport);
  console.error("PayPal MCP Server running on stdio");
}

main().catch((error) => {
  console.error("Fatal error in main():", error);
  process.exit(1);
});

与 MCP 主机（Claude Desktop/Cline/Cursor/Github Co-Pilot）一起使用

本指南介绍如何将 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. 导航到设置
3. 找到开发者或高级设置部分
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 设置为环境变量。您也可以使用 "args" 中的 --access-token 将其作为参数传递 将 PAYPAL_ENVIRONMENT 值设置为 SANDBOX 以进行阶段测试，将 PRODUCTION 用于生产环境。

6. 保存您的配置更改

3. 测试集成

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

可用工具

工具	描述	可用性
invoices.create	创建新发票	MCP 服务器
invoices.list	列出发票	MCP 服务器
createOrder	创建订单	ai-sdk
getOrder	获取订单详细信息	ai-sdk

环境变量

可以使用以下环境变量：

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

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

先决条件

• PayPal 开发者帐户（用于沙盒）
• PayPal 企业帐户（用于生产）

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

1. 创建 PayPal 开发者帐户：

   • 转到 PayPal 开发者仪表板
   • 使用您的 PayPal 凭据注册或登录

2. 访问您的凭据：

   • 在开发者仪表板中，单击菜单中的 Apps & Credentials
   • 根据您的需要，在 Sandbox 和 Live 模式之间切换

3. 创建或查看应用：

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

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. 在 Authorization 下，选择 Basic Auth 并输入您的客户端 ID 和客户端密钥
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. 避免在应用程序代码中硬编码令牌

免责声明

AI 生成的内容可能不准确或不完整。用户有责任在依赖任何信息之前独立验证任何信息。 PayPal 不保证输出的准确性，并且不对因使用而导致的任何决策、行动或后果负责。