Paypal

🚀 PayPal MCP Server

A Model Context Protocol (MCP) server that integrates with the PayPal API. This server enables seamless interaction with PayPal's payment processing, invoicing, subscription management, and business operations through a standardized interface.

🚀 Quick Start

This PayPal MCP Server offers seamless integration with the PayPal API. Follow the steps below to get started.

✨ Features

• Payment Processing: Create and capture payments, orders, and payment tokens.
• Subscription Management: Create and manage recurring subscriptions.
• Business Operations: Create products, generate invoices, and handle payouts.
• User Management: Retrieve user information and create web profiles.
• Security Authentication: Automatic token management and refresh handling.
• Input Validation: Comprehensive validation using Zod schemas.
• Error Handling: Robust error handling and logging.

📦 Installation

# Clone the repository
git clone https://github.com/arbuthnot-eth/PayPal-MCP-Backdated.git
cd PayPal-MCP-Backdated

# Install dependencies
npm install

# Build the project
npm run build

📚 Documentation

Configuration

Create a .env file in the root directory and add your PayPal API credentials:

PAYPAL_CLIENT_ID=your_client_id_here
PAYPAL_CLIENT_SECRET=your_client_secret_here
PAYPAL_ENVIRONMENT=sandbox  # or 'live' for production

Usage

Run the Server

# Start the server
npm start

# Auto - reload in development environment
npm run dev

MCP Configuration

Add the server to your MCP configuration file:

{
  "mcpServers": {
    "paypal": {
      "command": "node",
      "args": ["path/to/paypal-mcp/build/index.js"],
      "env": {
        "PAYPAL_CLIENT_ID": "your_client_id",
        "PAYPAL_CLIENT_SECRET": "your_client_secret",
        "PAYPAL_ENVIRONMENT": "sandbox"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Available Tools

Payment Tools

• create_payment_token: Create a payment token for future use.
• create_order: Create a new PayPal order.
• capture_order: Capture the payment of an authorized order.
• create_payment: Create a direct payment.
• create_subscription: Create a subscription for recurring billing.

Business Tools

• create_product: Create a new product in the catalog.
• create_invoice: Generate a new invoice.
• create_payout: Handle batch payouts.

User Tools

• get_userinfo: Retrieve user information.
• create_web_profile: Create a web experience profile.
• get_web_profiles: Get a list of web experience profiles.

Development

# Run code linting
npm run lint

# Execute tests
npm test

# Format code
npm run format

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.