@paddle/paddle-mcp

0.1.2 • Public • Published

MCP Server for Paddle Billing

Paddle Billing is the developer-first merchant of record. We take care of payments, tax, subscriptions, and metrics with one unified API that does it all.

This is a Model Context Protocol (MCP) server that provides tools for interacting with the Paddle API.

Important: This MCP server works with Paddle Billing. It does not support Paddle Classic. To work with Paddle Classic, see: Paddle Classic API reference

Features

  • List products in your Paddle catalog
  • Create new products
  • List prices for products
  • Create new prices for products
  • List customers
  • List transactions
  • List subscriptions
  • Create custom reports for financial analysis

Installation

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

You can run the Paddle MCP server using npx with the following command:

npx -y @paddle/paddle-mcp --api-key=PADDLE_API_KEY --environment=(sandbox|production)

Replace PADDLE_API_KEY with your API key, and pass the correct value as environment.

To run the server in a client like Claude Desktop, Cursor or Windsurf, add the following to your MCP config:

{
  "mcpServers": {
    "paddle": {
      "command": "npx",
      "args": ["-y", "@paddle/paddle-mcp", "--api-key=PADDLE_API_KEY", "--environment=(sandbox|production)"]
    }
  }
}

For detailed setup guides, see:

Development

  1. Install dependencies:

    pnpm install
  2. Build the server:

    pnpm build
  3. Update client to use the local build:

    {
      "mcpServers": {
        "paddle": {
          "command": "node",
          "args": ["path/to/paddle-mcp-server/build/index.js"],
          "env": {
            "PADDLE_API_KEY": "your_api_key",
            "PADDLE_ENVIRONMENT": "sandbox"
          }
        }
      }
    }

Debugging

To debug the MCP server, you can use the MCP Inspector tool:

  1. Run the server with the inspector:

    pnpm inspector
  2. Open the provided URL in your browser to view and debug the MCP requests and responses.

  3. Include the --api-key and --environment arguments.

Learn more

Package Sidebar

Install

npm i @paddle/paddle-mcp

Weekly Downloads

65

Version

0.1.2

License

Apache-2.0

Unpacked Size

48.3 kB

Total Files

10

Last publish

Collaborators

  • paullawford
  • dpaul96
  • jamescasley
  • miguelpaddle
  • samcolbypaddle
  • paddle.com
  • alecsammon
  • athanasu
  • marioarranzr
  • ligiapaddle
  • ioannispaddle
  • xyzale
  • im_gibson_paddle
  • redraushan
  • jonathan.lamb.paddle
  • leandrorondon-paddle
  • benjackson
  • snicol
  • colinbarrpaddle
  • vifer
  • dannygrimes
  • nacho.paddle
  • jordipaddle
  • ori.paddle
  • kieran-paddle
  • chrisguypaddle
  • arjan.paddle
  • rendeiro-g
  • jaypaddle
  • dilico
  • duffleone