# Checkout.com MCP Server

The Checkout.com Model Context Protocol (MCP) Server enables you to search through our knowledge base and investigate payment operations directly from your AI-assisted integrated development environment (IDE).

The MCP server provides access to payment operations tools, and unified access to the integration content from:

- This technical documentation site
- The [API reference](https://api-reference.checkout.com)
- The [support site](https://support.checkout.com)

It acts as a production-ready source of truth for AI tools such as Claude, GitHub Copilot, and Cursor, with the following benefits:

- Guided onboarding. Ask your AI agent to use the Guide tool to help you choose the best integration path for your use case and tech stack.
- In-app information. Search through the docs, browse API schemas, read integration guides, or troubleshoot issues directly from your code editor.
- Investigate, troubleshoot, and understand payment operations.
- Reduce hallucinations. Your AI agent has direct and structured access to the latest versions of the API reference and integration guides.
- Optimized token usage. Our AI-optimized context results in faster responses and lower AI interaction costs.

> **Information**
>
> If you have issues or want to provide feedback for the Checkout.com MCP Server, contact your account manager or [request support](https://dashboard.checkout.com/support/new?topic=case_configuration_change&issue=case_configuration_issue_operational_change_request).

---

## Add the MCP server to your IDE

> **Information**
>
> You must have an active [Dashboard](https://dashboard.checkout.com) account to authenticate with the Checkout.com MCP Server.

Add the MCP server to your IDE or AI tool's MCP configuration. The URL to connect varies depending on whether you want to connect to the production or sandbox MCP environment:

- Sandbox: `https://checkout.mcp.sbox.cko.tech`
- Production: `https://mcp.checkout.com`

Once connected, your AI agent can query and access native guidance to answer natural-language questions directly from your IDE.

**Claude Code**

1. Run the following command in the Claude Code terminal:

**Sandbox**

```bash
claude mcp add --transport http checkout-mcp-sandbox https://checkout.mcp.sbox.cko.tech
```

**Production**

```bash
claude mcp add --transport http checkout-mcp https://mcp.checkout.com
```

2. To trigger the MCP server's authentication flow, run the following command:

```bash
claude /mcp
```

3. Sign in using the credentials you use to access the Dashboard.

After you sign in successfully, you're redirected to Claude Code and your connection to the MCP server is enabled.

> **Information**
>
> If you're prompted to re-authenticate your connection to the MCP in a future session, run `claude /mcp` in the Claude Code terminal and follow the authentication flow steps again.

For more information, see Claude Code's [MCP](https://code.claude.com/docs/en/mcp#configure-mcp-servers) documentation.

**Claude Desktop**

1. Open the Claude Desktop application.
2. Run the following command in the Claude Desktop terminal:

**Sandbox**

```bash
claude mcp add --transport http checkout-mcp-sandbox https://checkout.mcp.sbox.cko.tech
```

**Production**

```bash
claude mcp add --transport http checkout-mcp https://mcp.checkout.com
```

3. To trigger the MCP server's authentication flow, run the following command:

```bash
claude /mcp
```

4. Sign in using the credentials you use to access the Dashboard.

After you sign in successfully, you're redirected to Claude Desktop and your connection to the MCP server is enabled.

> **Information**
>
> If you're prompted to re-authenticate your connection to the MCP in a future session, run `claude /mcp` in the Claude Desktop terminal and follow the authentication flow steps again.

For more information, see Claude Desktop's [MCP](https://platform.claude.com/docs/en/agents-and-tools/remote-mcp-servers) documentation.

**Cursor**

1. Open the Cursor application.
2. Open the `/.cursor/mcp.json` file located in your home or project directory.
3. Find the `mcpServers` object and add the Checkout MCP:

**Sandbox**

```json
{
  "mcpServers": {
    "checkout-mcp-sandbox": {
      "url": "https://checkout.mcp.sbox.cko.tech",
      "auth": {
        "CLIENT_ID": "checkout-mcp"
      }
    }
  }
}
```

**Production**

```json
{
  "mcpServers": {
    "checkout-mcp": {
      "url": "https://mcp.checkout.com",
      "auth": {
        "CLIENT_ID": "checkout-mcp"
      }
    }
  }
}
```

For more information, see Cursor's [MCP](https://cursor.com/docs/mcp#installing-mcp-servers) documentation.

**VS Code/GitHub Copilot**

1. Open the VS Code application.
2. On your keyboard, press `CMD + SHIFT + P` (macOS) or `CTRL + SHIFT + P` (Windows and Linux) to open the _Command Palette_.
3. Type `MCP: Open User Configuration` and select the matching entry.
4. In the file that opens, add the Checkout MCP:

**Sandbox**

```json
{
  "servers": {
    "checkout-mcp-sandbox": {
      "url": "https://checkout.mcp.sbox.cko.tech"
    }
  }
}
```

**Production**

```json
{
  "servers": {
    "checkout-mcp": {
      "url": "https://mcp.checkout.com"
    }
  }
}
```

5. Save the file.
6. On your keyboard, press `CMD + SHIFT + P` (macOS) or `CTRL + SHIFT + P` (Windows and Linux) to open the _Command Palette_ again.
7. Type `MCP: List Servers` and select the Checkout MCP in the list that appears.
8. Select _Start_.
9. In the _Authentication_ prompt that appears, select _Allow_.
10. In the _External Website_ prompt that appears, select _Open_.
11. Sign in using the credentials you use to access the Dashboard.

After you sign in successfully, you're redirected to VS Code and your connection to the MCP server is enabled.

For more information, see VS Code's [MCP servers](https://code.visualstudio.com/docs/copilot/customization/mcp-servers) documentation.

> **Information**
>
> For guidance on how to enable the MCP in any other IDE or AI tool, refer to their platform's remote MCP server documentation.

---

## Integration tools

The MCP provides the following tools to search through our knowledge base:

- `Guide` - Get guidance on the best integration path for your use case.
- `DocsSearch` - Search through content on the technical documentation site.
- `ApiSearch` - Search through content on the API reference.
- `SupportSearch` - Search through content on the support site.
- `ListOperations` - Lists available API operations.
- `GetOperation` - Retrieves details for a specific API operation.
- `GetSchema` - Retrieves schema information.

You can chain tools together via a natural language prompt. For example, you can send a message to your AI agent to:

```
Use the `Guide` and `ListOperations` tools to find which API operations and fields I need to create a payment request with PayPal.
```

---

## Payment operation tools

The MCP provides the following tools to perform payment operations:

- `Get Payment Details` - Query the status of a payment.
- `List Entities` - View your entities and change the active entity.

For example, you can send a message to your AI agent to:

```
Which entities do I have set up in my account?
```

---

## Disconnect the MCP server

To disconnect from the MCP server, disable it from your IDE's MCP settings or remove it from the JSON configuration file.