PayPal MCP Server

公式

PayPal Model Context Protocolサーバーを使用すると、関数呼び出しを通じてPayPal APIと統合できます。このプロトコルは、さまざまなPayPalサービスとやり取りするためのツールをサポートしています。

ドキュメント

PayPal エージェントツールキット

PayPal エージェントツールキットは、OpenAI の Agent SDK、LangChain、Vercel の AI SDK、Model Context Protocol (MCP) などの主要なエージェントフレームワークが、関数呼び出しを通じて PayPal API と統合できるようにします。TypeScript をサポートし、PayPal API と PayPal SDK 上に構築されています。

利用可能なツール

PayPal エージェントツールキットは、以下のツールを提供します。

請求書

create_invoice: PayPal システムで新しい請求書を作成します
list_invoices: ページネーションとフィルタリングを使用して請求書を一覧表示します
get_invoice: 特定の請求書の詳細を取得します
send_invoice: 請求書を受信者に送信します
send_invoice_reminder: 既存の請求書のリマインダーを送信します
cancel_sent_invoice: 送信済みの請求書をキャンセルします
generate_invoice_qr_code: 請求書の QR コードを生成します

支払い

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+

使用方法

ライブラリは、PayPal Developer Dashboard で入手可能なアカウントのクライアント ID とシークレットで設定する必要があります。

このツールキットは 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 モードです）

このガイドでは、クライアント ID とクライアントシークレットの確認方法を含め、PayPal API 統合用のアクセストークンを生成する方法について説明します。

前提条件

PayPal 開発者アカウント（サンドボックス用）
PayPal ビジネスアカウント（本番環境用）

クライアント ID とクライアントシークレットの確認

PayPal 開発者アカウントの作成:
- PayPal Developer Dashboard にアクセスします
- PayPal の認証情報でサインアップまたはログインします
認証情報へのアクセス:
- 開発者ダッシュボードで、メニューの Apps & Credentials をクリックします
- 必要に応じて Sandbox モードと Live モードを切り替えます
アプリの作成または表示:
- 新しいアプリを作成するには、Create App をクリックします
- アプリに名前を付け、関連付けるビジネスアカウントを選択します
- 既存のアプリの場合は、アプリ名をクリックして詳細を表示します
認証情報の取得:
- アプリを作成または選択すると、以下の情報が表示されます。
  - 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 を実際の認証情報に置き換えてください。本番環境では、サンドボックス URL の代わりに https://api-m.paypal.com を使用します。

Postman の使用

https://api-m.sandbox.paypal.com/v1/oauth2/token への新しいリクエストを作成します
メソッドを POST に設定します
Authorization で Basic Auth を選択し、クライアント ID とクライアントシークレットを入力します
Body で x-www-form-urlencoded を選択し、キー grant_type と値 client_credentials を追加します
リクエストを送信します

レスポンス

成功時のレスポンスは以下のようになります。

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

Claude Desktop 統合で使用するために access_token の値をコピーします。

トークンの詳細

サンドボックストークン: 3～8 時間有効
本番環境トークン: 8 時間有効
有効期限前にトークンを更新するロジックを実装することを推奨します

Claude Desktop でのトークンの使用

アクセストークンを取得したら、Claude Desktop コネクタ設定の PAYPAL_ACCESS_TOKEN の値を更新します。

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

ベストプラクティス

クライアント ID とクライアントシークレットを安全に保管します
トークンの有効期限に対応するため、トークン更新ロジックを実装します
環境固有のトークンを使用します（テストにはサンドボックス、実際の取引には本番環境）
アプリケーションコードにトークンをハードコーディングしないでください

免責事項

AI 生成コンテンツは不正確または不完全な場合があります。ユーザーは、情報に依拠する前に独自に検証する責任を負います。PayPal は出力の正確性について一切保証せず、その使用に起因するいかなる決定、行動、または結果についても責任を負いません。

PayPal MCP Server

ドキュメント

PayPal エージェント ツールキット

利用可能なツール

TypeScript

インストール

要件

使用方法

ワークフローの初期化

使用方法

ツールキットの使用

環境変数

前提条件

クライアント ID とクライアントシークレットの確認

アクセストークンの生成

cURL の使用

Postman の使用

レスポンス

トークンの詳細

Claude Desktop でのトークンの使用

ベストプラクティス

免責事項

PayPal エージェントツールキット