home / mcp / gocardless mcp server

GoCardless MCP Server

Installation

Add the following to your MCP client configuration file.

Configuration

{
  "mcpServers": {
    "jmceleney-gocardless-mcp": {
      "command": "gocardless-mcp",
      "args": [],
      "env": {
        "GOCARDLESS_ENVIRONMENT": "sandbox",
        "GOCARDLESS_ACCESS_TOKEN": "your_access_token_here"
      }
    }
  }
}

You can connect your AI assistants to GoCardless data through this MCP server, enabling you to list, view, and create customers, payments, mandates, subscriptions, and payouts, with handy Xero ID parsing. It’s designed to be easy to configure with your preferred MCP client and token-based access.

How to use

Use an MCP client to talk to the GoCardless MCP Server. You will authenticate with a GoCardless access token and choose sandbox or live mode. Through the available tools, you can fetch lists, retrieve individual records, and create new records within read-only guidance and safety limits.

How to install

Prerequisites you need before installing: a Python runtime and access to a GoCardless sandbox or live environment. You will also use an MCP client or containment tool (uvx, Claude, Cursor, or another stdio-based client) to run an MCP server process.

# For Claude Desktop integration (example of starting with a prebuilt MCP entry)
# Configure Claude Desktop to load the GoCardless MCP server with your token and environment
```}]} ,{

Configuration and usage notes

Configure your client with the required access token and environment. The server supports a sandbox or live environment; sandbox is the default. Keep your token secure and avoid sharing it in logs or public code.

{
  "mcpServers": {
    "gocardless": {
      "type": "stdio",
      "command": "gocardless-mcp",
      "args": [],
      "env": {
        "GOCARDLESS_ACCESS_TOKEN": "your_access_token_here",
        "GOCARDLESS_ENVIRONMENT": "sandbox"
      }
    }
  }
}
````}]} ,{

Data hierarchy and available actions

The data follows this pattern: Customer (CU*) → Mandate (MD*) → Subscription (SB*) or Payment (PM*). You can list or view customers, mandates, subscriptions, and payments, as well as list payouts. Subscriptions can be examined in detail, including related mandate and customer information when requested.

Customer -> Mandate -> Subscription or Payment

Available tools

list_customers

List all customers with optional limit, useful to browse your customer base.

get_customer

Retrieve a single customer by ID to view details and related links.

create_customer

Create a new customer with required email; optional fields include given_name, family_name, and company_name.

list_payments

List payments with optional filters like limit, status, subscription, or mandate.

get_payment

Get a specific payment by ID, including links to related mandate and subscription.

create_payment

Create a new payment with required amount, currency, and mandate_id; optional description.

list_mandates

List mandates with optional limit and customer filters.

get_mandate

Get a specific mandate by ID with a link to the customer.

list_subscriptions

List subscriptions with optional limit and status filters.

get_subscription

Get a specific subscription by ID with a link to the mandate.

get_subscription_details

Fetch complete subscription information including mandate and customer in one call.

list_payouts

List payouts with an optional limit parameter.