- Home
- MCP servers
- ChartMogul
ChartMogul
- python
7
GitHub Stars
python
Language
5 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"chartmogul-chartmogul-mcp-server": {
"command": "uv",
"args": [
"--directory",
"/path/to/your/local/chartmogul-mcp-server",
"run",
"main.py"
],
"env": {
"CHARTMOGUL_TOKEN": "<YOUR-CHARTMOGUL-TOKEN>"
}
}
}
}This MCP server connects ChartMogul data to your MCP client, enabling you to access accounts, customers, subscriptions, invoices, analytics, and other business data through a prepared set of endpoints. You can run a local MCP instance and point your client at it to perform common data-management and analytics tasks efficiently.
How to use
You run a local MCP server alongside your client to perform operations like retrieving account information, managing customers, handling subscriptions, and querying metrics. Start the server using the provided runtime and point your MCP client at the local port. The server exposes a broad set of actions such as listing data sources, creating and updating customers, managing invoices, and obtaining metrics like MRR, ARR, churn, and LTV.
How to install
Prerequisites: you need Node.js and npm if you follow the development flow, and you will use a runtime tool called uv to run the MCP server. Ensure you have Python installed because the main server entry uses a Python script. Prepare a token for ChartMogul access and place it in the environment when starting the server.
Step-by-step commands to configure and run the MCP server locally:
{
"mcpServers": {
"mcp-chartmogul": {
"command": "uv",
"args": [
"--directory",
"/path/to/your/local/chartmogul-mcp-server",
"run",
"main.py"
],
"env": {
"CHARTMOGUL_TOKEN": "<YOUR-CHARTMOGUL-TOKEN>"
}
}
}
}
Additional setup steps
-
Install and prepare the runtime for the MCP server. If you are following development steps, you may install uv via your preferred package manager or build from source following the guidance in the development flow.
-
Locate the runtime path for uv on your system and ensure the absolute path is used in the config entry to avoid path resolution issues.
-
Create a local environment file if proceeding with development, and populate the required token placeholder with your actual ChartMogul token.
Notes on usage and environment variables
The MCP server relies on an environment token to authorize interactions with ChartMogul data. Provide this token in the environment block of the MCP configuration. Restart the client after adding or updating environment variables to ensure the changes take effect.
Available tools
retrieve_account
Get account information for a specific ChartMogul account.
list_sources
List all data sources with optional filtering to locate relevant sources quickly.
retrieve_source
Get details for a specific data source by UUID.
list_customers
List customers with filtering options to narrow results.
search_customers
Search customers by email address.
retrieve_customer
Fetch a single customer by UUID.
create_customer
Create a new customer record.
update_customer
Update attributes of an existing customer.
list_customer_subscriptions
Retrieve subscriptions associated with a customer.
list_customer_activities
Get activities related to a customer.
list_customer_attributes
Fetch attributes associated with a customer.
add_customer_tags
Add tags to a customer for better categorization.
add_customer_custom_attributes
Attach custom attributes to a customer.
list_contacts
List all contacts.
retrieve_contact
Get a contact by UUID.
create_contact
Create a new contact.
update_contact
Update contact information.
list_customer_notes
List customer notes and call logs.
retrieve_customer_note
Get a specific customer note by UUID.
create_customer_note
Create a new note or call log for a customer.
update_customer_note
Update an existing customer note.
list_opportunities
List sales opportunities.
retrieve_opportunity
Get an opportunity by UUID.
create_opportunity
Create a new opportunity.
update_opportunity
Update opportunity details.
list_tasks
List tasks related to customers.
retrieve_task
Get a task by UUID.
create_task
Create a new task.
update_task
Update task information.
list_plans
List subscription plans.
retrieve_plan
Get a plan by UUID.
create_plan
Create a new plan.
update_plan
Update plan details.
list_plan_groups
List plan groups.
retrieve_plan_group
Get a plan group by UUID.
create_plan_group
Create a new plan group.
update_plan_group
Update a plan group.
list_plan_group_plans
List plans within a plan group.
all_metrics
Get all key metrics such as MRR, ARR, ARPA, ASP, customer count, churn rates, and LTV.
mrr_metrics
Get Monthly Recurring Revenue metrics.
arr_metrics
Get Annual Run Rate metrics.
arpa_metrics
Get Average Revenue Per Account metrics.
asp_metrics
Get Average Sale Price metrics.
customer_count_metrics
Get customer count metrics.
customer_churn_rate_metrics
Get customer churn rate metrics.
mrr_churn_rate_metrics
Get MRR churn rate metrics.
ltv_metrics
Get Customer Lifetime Value metrics.
list_subscription_events
List subscription events.
create_subscription_event
Create a new subscription event.
update_subscription_event
Update subscription event details.
list_invoices
List invoices with filtering.
import_invoices
Create new invoices.
retrieve_invoice
Get an invoice by UUID.
list_activities
List business activities such as new_biz, expansion, churn, etc.