Paypal MCP Server

PayPal Model Context Protocol

The PayPal Model Context Protocol server allows you to integrate with PayPal APIs through function calling. This protocol supports various tools to interact with different PayPal services.

To run the PayPal MCP server using npx, use the following command:

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

Replace YOUR_ACCESS_TOKEN with your PayPal access token. Refer this on how to generate a PayPal access token. Alternatively, you could set the PAYPAL_ACCESS_TOKEN in your environment variables.

Usage with MCP host (Claude Desktop/Cline/Cursor/GitHub Copilot)

This guide explains how to integrate the PayPal connector with Claude Desktop.

Prerequisites

• Claude Desktop application installed
• installing Node.js locally

Installation Steps

1. Install Node.js

Node.js is required for the PayPal connector to function:

1. Visit the Node.js official website, download and install it.
2. Requirements: Node 18+

2. Configure PayPal Connector with MCP host (Claude desktop / Cursor / Cline)

We will show the integration with Claude desktop. You can use your favorite MCP host.

1. Open Claude Desktop
2. Navigate to Settings
3. Find the Developer or Advanced settings section
4. Locate the external tools or connectors configuration area
5. Add the following PayPal connector configuration to this ~/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"
       }
     }
   }
}

Make sure to replace YOUR_PAYPAL_ACCESS_TOKEN with your actual PayPal Access Token. Alternatively, you could set the PAYPAL_ACCESS_TOKEN as an environment variable. You can also pass it as an argument using --access-token in "args" Set PAYPAL_ENVIRONMENT value as either SANDBOX for stage testing and PRODUCTION for production environment.

6. Save your configuration changes

3. Test the Integration

1. Quit and restart Claude Desktop to apply changes
2. Test the connection by asking Claude to perform a PayPal-related task
   • Example: "List my PayPal invoices"

Available tools

Invoices

• create_invoice: Create a new invoice in the PayPal system
• list_invoices: List invoices with optional pagination and filtering
• get_invoice: Retrieve details of a specific invoice
• send_invoice: Send an invoice to recipients
• send_invoice_reminder: Send a reminder for an existing invoice
• cancel_sent_invoice: Cancel a sent invoice
• generate_invoice_qr_code: Generate a QR code for an invoice

Payments

• create_order: Create an order in PayPal system based on provided details
• get_order: Retrieve the details of an order
• pay_order: Process payment for an authorized order
• create_refund: Process a refund for a captured payment.
• get_refund: Get the details for a specific refund.

Dispute Management

• list_disputes: Retrieve a summary of all open disputes
• get_dispute: Retrieve detailed information of a specific dispute
• accept_dispute_claim: Accept a dispute claim

Shipment Tracking

• create_shipment_tracking: Create a shipment tracking record
• get_shipment_tracking: Retrieve shipment tracking information

Catalog Management

• create_product: Create a new product in the PayPal catalog
• list_products: List products with optional pagination and filtering
• show_product_details: Retrieve details of a specific product
• update_product: Update an existing product

Subscription Management

• create_subscription_plan: Create a new subscription plan
• update_plan: Update an existing plan
• list_subscription_plans: List subscri

... View full README on GitHub