zuora-mcp-test
v2.0.0-beta.1
Published
Zuora Developer MCP
Maintainers
Readme
Zuora Developer MCP (Model Context Protocol) – Beta Preview
The Zuora Developer MCP Server connects your AI IDE directly to Zuora, giving you access to Zuora tools, resources, and prompts from within Claude Desktop, Cursor, Windsurf, and other MCP-compatible clients.
⚠️ Breaking Changes in 2.0.0-beta.1
This release is a major change. If you depend on previous behavior, pin to [email protected] (see Pinning a version).
| Change | Previous (≤ 1.0.0-beta.7) | Current (≥ 2.0.0-beta.1) |
|--------|---------------------------|--------------------------|
| Approval process | zuora_approval tool enforced approval for mutating operations | Removed. All operations execute immediately. |
| Auth required | zuora_codegen and sdk_upgrade worked without credentials | All tools require ZUORA_BASE_URL, ZUORA_CLIENT_ID, and ZUORA_CLIENT_SECRET |
| Tool availability | Fixed set of tools | Dynamically discovered — tools update automatically |
Pinning a version
To keep using the previous behavior, specify the version in your MCP config:
{
"mcpServers": {
"zuora-developer-mcp": {
"command": "npx",
"args": ["-y", "[email protected]"],
"env": {
"ZUORA_BASE_URL": "{baseUrl}",
"ZUORA_CLIENT_ID": "{clientId}",
"ZUORA_CLIENT_SECRET": "{clientSecret}"
}
}
}
}🔐 Prerequisites
- Node.js and npm installed on your local machine.
- Valid Zuora API credentials.
- An IDE that supports MCP configuration (e.g. Cursor, Windsurf, Claude Desktop).
⚙️ Environment Variables
Required
ZUORA_BASE_URL: Your Zuora base URL or MCP endpoint. Accepts either format:- REST base URL:
https://rest-staging2.zuora.com(appends/mcpautomatically) - MCP endpoint:
https://apisandbox.zuora.com/mcp(used as-is)
You can find your base URL here. For backward compatibility,
BASE_URLis also supported but deprecated.- REST base URL:
ZUORA_CLIENT_ID: Your Zuora API client ID.ZUORA_CLIENT_SECRET: Your Zuora API client secret.
Optional
ZUORA_VERSION: Zuora API version header.ZUORA_ENTITY_IDS: Entity ID(s) for Zuora Multi-Entity setups (comma-separated).ZUORA_ORG_IDS: Org ID(s) for Zuora Multi-Org environments (comma-separated).REMOTE_MCP_TIMEOUT_MS: Per-request timeout in milliseconds (default:120000).
🚀 Quick Start
Add the following to your MCP config:
{
"mcpServers": {
"zuora-developer-mcp": {
"command": "npx",
"args": ["-y", "zuora-mcp"],
"env": {
"ZUORA_BASE_URL": "{baseUrl}",
"ZUORA_CLIENT_ID": "{clientId}",
"ZUORA_CLIENT_SECRET": "{clientSecret}"
}
}
}
}For detailed setup guides, see:
Add the MCP rules to Cursor's User Rules. See cursor_rules.md for details.
📘 Changelog
2.0.0-beta.1 ⚠️ Breaking
- Removed approval process — all operations execute immediately.
- All tools now require Zuora credentials.
- Tools, resources, and prompts update automatically.
- OAuth tokens refresh automatically.
1.0.0-beta.7
- Added
manage_billing_previewstool for previewing billing before invoice generation. - Added
manage_billing_documentstool for managing billing document PDF and email operations. - Added org scoping support via the
ZUORA_ORG_IDSenvironment variable. - Renamed tools to follow plural naming convention.
- Renamed
BASE_URLtoZUORA_BASE_URL(BASE_URLstill supported but deprecated).
1.0.0-beta.6
- Added
renew_subscriptionstool. - Added
get_account_summarytool. - Added entity scoping support via the
ZUORA_ENTITY_IDSenvironment variable.
1.0.0-beta.5
- Added
cancel_subscriptionstool. - Added
manage_revenue_reportstool for Zuora Revenue (RevPro) report management.
1.0.0-beta.4
- Internal improvements.
1.0.0-beta.3
- Split
zuora_workflowtool intorun_workflowsandmanage_workflows.
1.0.0-beta.2
- Added
run_reports,manage_reports, andrun_workflowstools.
1.0.0-beta.1
- Added
query_objects,create_products,create_product_rate_plans,create_product_rate_plan_charges,create_subscriptions.
Previous Alpha Versions
- API knowledge base, SDK upgrades, Cursor workspace rules, and telemetry improvements.
