Welcome to Zuora Product Documentation

Explore our rich library of product information

Resources reference for Zuora MCP

This reference lists the resource guides available for Zuora MCP and describes when to use each one.

GuideDescription
analytics-column-configsUse this guide to choose the correct column configuration for analytics queries. It includes decision trees based on metric and aggregationType, correct and incorrect examples, and common error scenarios.
analytics-query-request-guideUse this guide as a complete reference for DataSetQueryRequest. It explains all request fields, filter operators, time-based aggregation, pagination, and validation rules, and includes 21 working examples.
analytics-schema-fieldsUse this guide for field-by-field documentation of the schema that get_dataset_schema returns. It explains fields such as metric, aggregate, aggregationType, type, options, pivot, and units, and includes decision trees to help you interpret them.
analytics-schema-to-queryUse this guide to convert a MaterializedDataSetResponse schema into a valid DataSetQueryRequest. It explains when to use column IDs instead of labels, how to build filters, and how to choose the correct columnConfigs values.
product-catalog-guideUse this guide to create or extend Zuora Billing product catalog records. It covers product, rate plan, and charge creation with create_products, create_product_rate_plans, and create_product_rate_plan_charges.
orders-guideUse this guide to work with order and subscription lifecycle workflows in Zuora. It covers common flows that use create_subscriptions, manage_orders, manage_subscriptions, and manage_subscription_amendments.
query-guideUse this guide to decide whether to use query_objects or manage_data_queries. It includes routing logic, quick-reference guidance, and anti-examples to help you choose the right tool.
contract-modification-guideUse this guide for help with the manage_contract_modification tool for ASC 606 contract modification analysis. It explains supported operations, period resolution, intent-based routing, response formatting, and guidance for SSP and allocation narration.
revenue-job-summary-guideUse this guide for help with the manage_revenue_job_summary tool.
revenue-switch-allocation-guideUse this guide to preview a revenue contract allocation switch with the manage_revenue_switch_allocation tool. It explains how the tool simulates an ASC 606 Step 4 allocation switch, compares old and new allocation values by performance obligation, and remains read-only.
simulate-revenue-impact-guideUse this guide for help with the simulate_revenue_impact tool. It covers parameters, examples, error handling, ASC 606 narration, and response formatting.
summarize-revenue-report-guideUse this guide for help with the summarize_revenue_report tool.