For AI agents and LLMs: a structured documentation index is available at /llms.txt. Every page has a Markdown sibling — append .md to any URL.

Skip to content
Docs

Docs MCP server

Connect AI agents to current Paddle documentation, the OpenAPI specification, and SDK references using the Paddle docs MCP server.

AI summary

Install the Paddle docs MCP server so your AI agent can search current Paddle documentation, the OpenAPI spec, and SDK references on demand instead of relying on stale training data. The server runs remotely on Kapa.ai at https://paddlehq.mcp.kapa.ai.

  • • The server uses HTTP transport at https://paddlehq.mcp.kapa.ai and indexes Paddle docs, the OpenAPI specification, and references for the Node.js, Python, Go, and PHP SDKs.
  • • Setup snippets are provided for Claude Desktop, Claude Code, Codex, Cursor, VS Code, Raycast, ChatGPT Desktop, Windsurf, Zed, and Antigravity, with one-click install links where supported.
  • • If your agent isn't calling the MCP server, prompt it to use 'up-to-date Paddle documentation' explicitly — agents default to training data without guidance.

The Paddle docs MCP server gives AI agents full, current knowledge of Paddle so you can build, integrate, and troubleshoot without relying on stale training data.

How it works

AI agents are only as good as what they know. Without access to current documentation, they can give outdated advice, miss important details, or confidently suggest things that no longer work.

The Paddle docs MCP server gives your agent access to up-to-date-Paddle documentation. Install it once and your AI agent can search all public Paddle resources, including:

Install the docs MCP server

The server runs remotely on Kapa.ai.

  1. Open Claude Desktop and go to Settings > Developer > Edit Config.
  2. In the claude_desktop_config.json file, add the paddle-docs server configuration to the mcpServers object.
  3. Save the file and restart Claude Desktop.
JSON
{
  "mcpServers": {
    "paddle-docs": {
      "type": "http",
      "url": "https://paddlehq.mcp.kapa.ai"
    }
  }
}

Run the following command in your terminal:

Shell
claude mcp add --transport http paddle-docs https://paddlehq.mcp.kapa.ai
  1. Run codex mcp add --transport http paddle-docs https://paddlehq.mcp.kapa.ai in your terminal.
  2. Run codex mcp login paddle-docs --scopes openid to print an authorization URL.
  3. Manually append &resource=https%3A%2F%2Fpaddle-docs.mcp.kapa.ai%2F to the end of the authorization URL.
  4. Open the authorization URL in your browser and complete the authentication flow.

The full URL should look something like:

text
https://mcp.kapa.ai/auth/public/authorize?...&scope=openid&resource=https%3A%2F%2Fpaddle-docs.mcp.kapa.ai%2F

One-click install

Install the Paddle docs MCP in Cursor

Manual install

  1. Open Cursor Settings > MCP Tools (or Command / Ctrl + Shift + J > MCP Tools).
  2. Click Add Custom MCP to open the mcp.json file.
  3. Add the paddle-docs server configuration to the mcpServers object.
  4. Save the file and restart Cursor.
JSON
{
  "mcpServers": {
    "paddle-docs": {
      "type": "http",
      "url": "https://paddlehq.mcp.kapa.ai"
    }
  }
}

One-click install

Install the Paddle docs MCP in VS Code

Manual install

  1. Press Command / Ctrl + Shift + P to open the command palette.
  2. Search and select MCP: Add Server... .
  3. Select HTTP as the server type.
  4. Enter https://paddlehq.mcp.kapa.ai as the server URL.
  5. Enter paddle-docs as the server name.
  6. Click User Settings .
  7. Restart VS Code.
  1. Open ChatGPT Desktop and go to Settings > Features.
  2. Enable Developer mode.
  3. Navigate to Settings > MCP Servers > Add Server.
  4. Enter paddle-docs as the server name and https://paddlehq.mcp.kapa.ai as the URL.
  5. Complete the authentication flow when prompted.
  1. In the Agent sidebar, click the button, then Open MCP Config File .
  2. Add the paddle-docs server configuration to the mcpServers object.
  3. Save the file and reload Windsurf.
  4. Complete the authentication flow when prompted.
JSON
{
  "mcpServers": {
    "paddle-docs": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://paddlehq.mcp.kapa.ai"
      ]
    }
  }
}
  1. Run npx mcp-remote https://paddlehq.mcp.kapa.ai in your terminal to authenticate your session.
  2. Add the paddle-docs server to the context_servers block in ~/.config/zed/settings.json.
  3. Reload Zed.
JSON
{
  "context_servers": {
    "paddle-docs": {
      "source": "custom",
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://paddlehq.mcp.kapa.ai"
      ],
      "env": {}
    }
  }
}
  1. In the Agent sidebar, click the button, then MCP Servers .
  2. Click Manage MCP Servers , then View raw config .
  3. Add the paddle-docs server configuration to the mcpServers object.
  4. Save the file and click Refresh .
  5. Complete the authentication flow when prompted.
JSON
{
  "mcpServers": {
    "paddle-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://paddlehq.mcp.kapa.ai"
      ]
    }
  }
}

For any other MCP-compatible client, configure the server manually with these details:

SettingValue
Namepaddle-docs
Typehttp
URLhttps://paddlehq.mcp.kapa.ai
JSON
{
  "mcpServers": {
    "paddle-docs": {
      "type": "http",
      "url": "https://paddlehq.mcp.kapa.ai"
    }
  }
}

Once installed, you may be prompted to authenticate with Kapa.ai. This check keeps the service reliable and secure for everyone.

Use the server

Once connected, your AI agent can search the Paddle docs, OpenAPI spec, and SDK references automatically when needed. You don't need to configure it to use it.

Most agents show you when an MCP server is used. If yours doesn't, ask it to use up-to-date information from the Paddle documentation. That encourages it to call the tool rather than rely on training data.

Example prompts

Use these example prompts to get started.

Integrate Paddle

markdown
Using the latest Paddle documentation, what's the correct way to verify a webhook signature in my current Node.js implementation?

Understand the API

markdown
Check the Paddle docs and tell me which fields I need to include when creating a one-time charge on an existing subscription.

Debug an issue

markdown
Looking at the current Paddle documentation, what are the most likely causes of a `too_many_requests` error when calling the transactions endpoint, and how should I handle it?

Plan a migration

markdown
Based on the current Paddle docs, what are the main differences between Paddle Classic and Paddle Billing, and what would I need to update in my existing integration to migrate?

Build a checkout

markdown
Using up-to-date Paddle documentation, plan how to add an overlay, one-page Paddle Checkout to my existing Next.js pricing page.

Manage subscriptions

markdown
Using up-to-date Paddle documentation, give me detailed instructions on how to open a customer portal for my customers to manage their subscriptions.

Was this page helpful?