Available tools

The MCP server can use the following tools to take actions with your Paddle account:

<details>
<summary>Products</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List products | list_products | ✅ | ✅ |
| Create a product | create_product | ✅ | ❌ |
| Get a product | get_product | ✅ | ✅ |
| Update a product | update_product | ❌ | ❌ |

</details>

<details>
<summary>Prices</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List prices | list_prices | ✅ | ✅ |
| Create a price | create_price | ✅ | ❌ |
| Get a price | get_price | ✅ | ✅ |
| Update a price | update_price | ❌ | ❌ |
| Preview prices | preview_prices | ✅ | ❌ |

</details>

<details>
<summary>Discounts</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List discounts | list_discounts | ✅ | ✅ |
| Create a discount | create_discount | ✅ | ❌ |
| Get a discount | get_discount | ✅ | ✅ |
| Update a discount | update_discount | ❌ | ❌ |

</details>

<details>
<summary>Discount Groups</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List discount groups | list_discount_groups | ✅ | ✅ |
| Create a discount group | create_discount_group | ✅ | ❌ |
| Get a discount group | get_discount_group | ✅ | ✅ |
| Update a discount group | update_discount_group | ❌ | ❌ |
| Archive a discount group | archive_discount_group | ❌ | ❌ |

</details>

<details>
<summary>Customers</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List customers | list_customers | ✅ | ✅ |
| Create a customer | create_customer | ✅ | ❌ |
| Get a customer | get_customer | ✅ | ✅ |
| Update a customer | update_customer | ❌ | ❌ |
| List credit balances for a customer | list_credit_balances | ✅ | ✅ |

</details>

<details>
<summary>Addresses</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List addresses for a customer | list_addresses | ✅ | ✅ |
| Create an address for a customer | create_address | ✅ | ❌ |
| Get an address for a customer | get_address | ✅ | ✅ |
| Update an address for a customer | update_address | ❌ | ❌ |

</details>

<details>
<summary>Businesses</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List businesses for a customer | list_businesses | ✅ | ✅ |
| Create a business for a customer | create_business | ✅ | ❌ |
| Get a business for a customer | get_business | ✅ | ✅ |
| Update a business for a customer | update_business | ❌ | ❌ |

</details>

<details>
<summary>Transactions</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List transactions | list_transactions | ✅ | ✅ |
| Create a transaction | create_transaction | ✅ | ❌ |
| Get a transaction | get_transaction | ✅ | ✅ |
| Update a transaction | update_transaction | ❌ | ❌ |
| Preview a transaction | preview_transaction_create | ✅ | ❌ |
| Revise customer information on a billed or completed transaction | revise_transaction | ❌ | ❌ |
| Get a PDF invoice for a transaction | get_transaction_invoice | ✅ | ✅ |

</details>

<details>
<summary>Adjustments</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List adjustments | list_adjustments | ✅ | ✅ |
| Create an adjustment | create_adjustment | ✅ | ❌ |
| Get a PDF credit note for an adjustment | get_adjustment_credit_note | ✅ | ✅ |

</details>

<details>
<summary>Subscriptions</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List subscriptions | list_subscriptions | ✅ | ✅ |
| Get a subscription | get_subscription | ✅ | ✅ |
| Update a subscription | update_subscription | ❌ | ❌ |
| Cancel a subscription | cancel_subscription | ❌ | ❌ |
| Pause a subscription | pause_subscription | ❌ | ❌ |
| Resume a paused subscription | resume_subscription | ❌ | ❌ |
| Activate a trialing subscription | activate_subscription | ❌ | ❌ |
| Preview an update to a subscription | preview_subscription_update | ✅ | ❌ |
| Create a one-time charge for a subscription | create_subscription_charge | ✅ | ❌ |
| Preview a one-time charge for a subscription | preview_subscription_charge | ✅ | ❌ |

</details>

<details>
<summary>Saved Payment Methods</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List payment methods saved for a customer | list_saved_payment_methods | ✅ | ✅ |
| Get a payment method saved for a customer | get_saved_payment_method | ✅ | ✅ |
| Delete a payment method saved for a customer | delete_saved_payment_method | ❌ | ❌ |

</details>

<details>
<summary>Customer Portal Sessions</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| Create a customer portal session | create_customer_portal_session | ✅ | ❌ |

</details>

<details>
<summary>Notification Settings</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List notification settings | list_notification_settings | ✅ | ✅ |
| Create a notification setting | create_notification_setting | ✅ | ❌ |
| Get a notification setting | get_notification_setting | ✅ | ✅ |
| Update a notification setting | update_notification_setting | ❌ | ❌ |
| Delete a notification setting | delete_notification_setting | ❌ | ❌ |

</details>

<details>
<summary>Events</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List events | list_events | ✅ | ✅ |

</details>

<details>
<summary>Notifications</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List notifications | list_notifications | ✅ | ✅ |
| Get a notification | get_notification | ✅ | ✅ |
| Replay a notification | replay_notification | ✅ | ❌ |

</details>

<details>
<summary>Notification Logs</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List logs for a notification | list_notification_logs | ✅ | ✅ |

</details>

<details>
<summary>Simulations</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List simulations | list_simulations | ✅ | ✅ |
| Create a simulation | create_simulation | ✅ | ❌ |
| Get a simulation | get_simulation | ✅ | ✅ |
| Update a simulation | update_simulation | ❌ | ❌ |

</details>

<details>
<summary>Simulation Runs</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List runs for a simulation | list_simulation_runs | ✅ | ✅ |
| Create a run for a simulation | create_simulation_run | ✅ | ❌ |
| Get a run for a simulation | get_simulation_run | ✅ | ✅ |

</details>

<details>
<summary>Simulation Run Events</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List events for a simulation run | list_simulation_run_events | ✅ | ✅ |
| Get an event for a simulation run | get_simulation_run_event | ✅ | ✅ |
| Replay an event for a simulation run | replay_simulation_run_event | ✅ | ❌ |

</details>

<details>
<summary>Reports</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List reports | list_reports | ✅ | ✅ |
| Create a report | create_report | ✅ | ❌ |
| Get a report | get_report | ✅ | ✅ |
| Get a CSV file for a report | get_report_csv | ✅ | ✅ |

</details>

<details>
<summary>Client-Side Tokens</summary>

| Operation | Tool | Non-destructive | Read only |
|-----------|------|-----------------|-----------|
| List client-side tokens | list_client_side_tokens | ✅ | ✅ |
| Create a client-side token | create_client_side_token | ✅ | ❌ |
| Get a client-side token | get_client_side_token | ✅ | ✅ |
| Revoke a client-side token | revoke_client_side_token | ❌ | ❌ |

</details>

Installation

To use the MCP server, you'll need an API key. You can create and manage API keys in Paddle > Developer tools > Authentication:

Adding the following to your MCP settings file will configure and run the Paddle MCP server in a client like Claude Desktop, Cursor or Windsurf:

Method 1: One-click installation in Cursor or VS Code

You can install the Paddle MCP server with a single click in Cursor or VS Code.

<a href="vscode:mcp/install?%7B%22name%22%3A%22paddle%22%2C%22type%22%3A%22stdio%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40paddle%2Fpaddle-mcp%22%5D%2C%22env%22%3A%7B%22PADDLE_API_KEY%22%3A%22your-api-key%22%2C%22PADDLE_ENVIRONMENT%22%3A%22sandbox%22%2C%22PADDLE_MCP_TOOLS%22%3A%22non-destructive%22%7D%7D">

</a>

After installation, you'll need to update the configuration in your MCP settings file to replace your_api_key with your actual Paddle API key and adjust the environment and tools values as needed.

Method 2: Using command-line arguments (Recommended for npx)

Add the following to the MCP settings or configuration file in the client you're using:

{
  "mcpServers": {
    "paddle": {
      "command": "npx",
      "args": [
        "-y",
        "@paddle/paddle-mcp",
        "--api-key=your_api_key",
        "--environment=sandbox",
        "--tools=non-destructive"
      ]
    }
  }
}

Replace your_api_key with your actual Paddle API key, set --environment to either sandbox or production, and set --tools to the tools which you want to be loaded and available to the MCP client.

Method 3: Using environment variables

Add the following to the MCP settings or configuration file in the client you're using:

{
  "mcpServers": {
    "paddle": {
      "command": "npx",
      "args": ["-y", "@paddle/paddle-mcp"],
      "env": {
        "PADDLE_API_KEY": "your_api_key",
        "PADDLE_ENVIRONMENT": "sandbox",
        "PADDLE_MCP_TOOLS": "non-destructive"
      }
    }
  }
}

Replace your_api_key with your actual Paddle API key, set PADDLE_ENVIRONMENT to either sandbox or production, and set PADDLE_MCP_TOOLS to the tools which you want to be loaded and available to the MCP client.

Filtering tools

You can filter which tools are loaded and available to the MCP client by passing the --tools argument (Method 2) or setting the PADDLE_MCP_TOOLS environment variable (Method 1 or 3). Accepted values are:

For detailed setup guides, see: