Docs

Log in to read the version of docs relevant to your site, or use the dropdown versions

Chargebee MCP Server

The Model Context Protocol (MCP) is a standardized mechanism that connects large language models (LLMs) to external systems through structured, context-aware communication.

The Chargebee MCP Agent Server extends this protocol with streamable HTTP connections, enabling real-time interaction between Chargebee Agents and clients such as AI-powered code editors like Cursor and Windsurf, or general-purpose tools like Claude Desktop, along with other compatible IDEs and orchestration systems.

This version is fully hosted, agent-based, and designed for low-latency streaming over secure HTTP endpoints.

Architecture and Components

1. Agent-based Design

Each Chargebee Agent also functions as a dedicated MCP endpoint exposing tools and skills specific to a particular use case (e.g., data look up, onboarding, or documentation lookup).

Every agent is deployed at its own endpoint

https://<your-site-id>.mcp.chargebee.com/<agent-name>

2. Streamable HTTP Transport

The Chargebee MCP Agent Server exclusively supports Streamable HTTP transport, ensuring standardized and real-time communication through modern, event-driven semantics compatible with MCP clients. The minimum supported protocol version is 2025-06-18.

3. Authentication

All agent servers (except the public Knowledge Base Agent) require authentication via an API key:

Authorization: Bearer <your-api-key>

API keys are generated from the Agent Configuration section in your Chargebee dashboard.

OAuth 2.1–based authentication support will be added soon.

Supported Agents

AgentDescriptionAccess
Knowledge Base AgentProvides detailed explanations of Chargebee features, API endpoints, and documentation.Public
Data Lookup AgentRetrieves customer, subscription, invoice, and credit note information from your Chargebee site.Requires API key
Onboarding AgentAutomates setup for product catalogs, pricing models, and customer data in Test Sites.Requires API key

Each agent exposes its own tools and skills for MCP clients.

Example: Integrating Knowledge Base Agent

Endpoint

https://<your-site-name>.mcp.chargebee.com/knowledge_base_agent

You can find your Chargebee site name by logging into your Chargebee dashboard and looking at the URL, which typically follows the format your-site-name.chargebee.com.

Cursor

To add this server to Cursor IDE:

  1. Navigate to Cursor Settings > MCP.
  2. Click + New MCP Server.
  3. Add the following configuration to your global .cursor/mcp.json file:
{
  "mcpServers": {
    "chargebee-knowledge-base": {
      "url": "https://<your-site-name>.mcp.chargebee.com/knowledge_base_agent"
    }
  }
}

Refer to the Cursor documentation for additional details

Claude Code

Use the following command to add Chargebee Agent MCP Server

claude mcp add --transport http chargebee-knowledge-base https://<your-site-name>.mcp.chargebee.com/knowledge_base_agent

Example: Integrating Data Lookup Agent

Endpoint

https://<your-site-name>.mcp.chargebee.com/data_lookup_agent
You can find your Chargebee site name by logging into your Chargebee dashboard and looking at the URL, which typically follows the format your-site-name.chargebee.com. You can get the API Key from the agent configuration page.

Cursor

To add this server to Cursor IDE:

  1. Navigate to Cursor Settings > MCP
  2. Click + New MCP Server
  3. Add the following configuration to your global .cursor/mcp.json file:
{
  "mcpServers": {
    "chargebee-data-lookup": {
      "url": "https://<your-site-name>.mcp.chargebee.com/data_lookup_agent",
      "headers": {
        "Authorization": "Bearer <your-api-key>"
      }
    }
  }
}

Refer to the Cursor documentation for additional details.

Claude Code

Use the following command to add Chargebee Agent MCP Server

claude mcp add --transport http chargebee-data-lookup https://<your-site-name>.mcp.chargebee.com/data_lookup_agent --header "Authorization: Bearer <your-api-key>"

Was this article helpful?