Skip to navigation

Tools reference for Zuora MCP

View as Markdown

Comprehensive reference for all Zuora AI tools, their permissions, and supported operations across Zuora APIs.

This section provides a detailed reference of all available tools and operations for documentation team reference. It may be published separately or summarized for end users.

Zuora AI provides 91 tools covering 330+ operations across Zuora’s APIs. Each tool has a permission classification:

  • READ: Only reads data; available in tenants on any mode (Read-Only, Read-Only (opted into Supervised mode), Supervised, or Autonomous).
  • WRITE: Modifies data; requires the tenant to be in Supervised or Autonomous mode.
  • MIXED: Contains both read and write operations. Read operations are available in any mode; write operations require Supervised or Autonomous mode.

Use the built-in AI capabilities to explore the server’s available features and tools. For example, ask “What can I do with the manage_workflow tool?” You can also request guidance on using a specific tool or Zuora feature, such as “Give me five useful prompts for working with invoices.”

Knowledge and Guidance

Tool

AI

Permission

Description

ask_zuora

Read

Expert assistant on Zuora’s product suite.

sdk_upgrade

Read

SDK version information, changelogs, and upgrade guidance.

zuora_codegen

Read

Code generation guidance with API discovery.

ping

Read

Checks whether the Zuora MCP server is available and responding.

Query and Data

ToolPermissionDescription
get_account_summaryReadAccount details with financial summary.
query_objectsReadQuery Zuora object types with filtering and sorting.
manage_data_queriesReadSubmit and manage Data Query jobs.
manage_reportsMixedSearch, list, export, and manage reports.
manage_system_healthReadRetrieve API volume, failures, and summaries.
run_reportsWriteRuns a report.
submit_mcp_feedbackReadSubmits confirmed MCP feedback for the Zuora MCP server.
zuora_graphqlReadExplores GraphQL types, filters, inputs, and query structures, and runs GraphQL queries.

Billing and Subscriptions

ToolPermissionDescription
create_productsWriteCreate products in the product catalog.
create_product_rate_plansWriteCreate rate plans under products.
create_product_rate_plan_chargesWriteCreate charges.
create_subscriptionsWriteCreate subscriptions through the Orders API.
manage_subscriptionsMixedSuspend, resume, renew, cancel, and preview subscriptions.
manage_subscription_amendmentsWriteAdd, update, and remove products.
manage_ordersMixedPreview, create, update, and cancel orders.
manage_billing_previewsMixedGenerate and retrieve billing previews.
manage_bill_runsMixedCreate, post, cancel, and delete bill runs.
manage_invoice_schedulesMixedCreate and manage invoice schedules.
manage_fulfillmentsWriteCreates, updates, and deletes fulfillments and fulfillment items.

Invoicing and Accounts Receivable

ToolPermissionDescription
manage_invoicesMixedCreate, post, reverse, write off, and email invoices.
manage_credit_memosMixedCreate, post, apply, and reverse credit memos.
manage_debit_memosMixedCreate, post, and write off debit memos.
manage_billing_documentsMixedGenerate billing documents and manage PDFs.
manage_taxation_itemsWriteCreate, update, and delete taxation items.
manage_summary_statementsWriteCreate summary statement runs.
manage_delivery_adjustmentsMixedPreview, create, and cancel adjustments.

Payments

ToolPermissionDescription
manage_paymentsWriteCreate, apply, unapply, cancel, refund, and transfer payments.
manage_refundsWriteDelete, update, and cancel refunds.
manage_payment_runsWriteCreate, update, and delete payment runs.
manage_payment_schedule_itemsWriteRetry, cancel, and skip payment schedule items.
manage_payment_schedulesWriteCreates, updates, deletes, and cancels payment schedules, and adds items to payment schedules.

Accounts and Contacts

ToolPermissionDescription
manage_customer_accountsMixedRetrieves customer account settings and creates, updates, and deletes customer accounts.
manage_contactsWriteCreate, update, delete, and transfer contacts.

Revenue

ToolPermissionDescription
manage_accounting_codesMixedList, create, activate, and deactivate accounting codes.
manage_accounting_periodsMixedList, create, close, and reopen accounting periods.
manage_journal_runsMixedCreate, cancel, and delete journal runs.
manage_summary_journal_entriesMixedCreate, update, and cancel summary journal entries.
manage_revenue_reportsReadList, run, and download revenue reports.
summarize_revenue_reportReadSummarizes revenue report output.
manage_o2r_data_backfillMixedManage O2R data backfill jobs.
manage_o2r_regenerateWriteRegenerate transactions and revenue recognition events.
manage_revenue_switch_allocationReadRetrieves revenue switch allocation information.
manage_contract_modificationReadRetrieves contract modification details and analyzes TCV changes, pricing by line, and carve impacts.
manage_revenue_job_summaryReadCollects revenue job metrics and lists failed revenue job runs.
simulate_revenue_impactReadSimulates revenue impact, including TCV, revenue by quarter, and remaining performance obligations.
manage_stage_validationMixedLists, searches, and retrieves field information and validation rules, and saves stage validation rules.
get_rule_setReadRetrieves rule set information.
manage_vcMixedRetrieves VC types and applies VC actions.
manage_defer_and_releaseWriteDefers revenue for revenue contracts and releases revenue for revenue contracts.
manage_apply_holdWriteApplies holds at the contract, line, and POB levels.
manage_release_holdWriteReleases holds at the contract, line, and POB levels.
manage_allocate_actionWriteRuns allocation actions.
manage_open_close_rcWriteOpens and closes revenue contracts.
manage_edit_lineWriteEdits revenue contract lines.
manage_switch_allocationWriteSwitches revenue allocation.
manage_apply_impairmentWriteApplies impairment actions.
manage_edit_pob_attributesWriteEdits POB attributes at the revenue contract and POB levels.
manage_switch_lead_lineWriteSwitches the lead line.
manage_un_freeze_rcWriteUnfreezes revenue contracts.
manage_link_delinkWriteLinks and delinks revenue contracts, POBs, and lines.
manage_generate_forecastWriteGenerates revenue forecasts.

Administration and Analytics

ToolPermissionDescription
manage_settingsMixedRetrieve and update tenant settings.
manage_analyticsReadValidates analytics access, lists datasets, retrieves dataset schemas, and executes analytics queries.
manage_decision_treeWriteCreates and updates decision trees.
manage_custom_functionWriteCreates and updates custom functions for workflows.
manage_workflowsMixedList, export, import, and update workflows.
manage_workflow_tasksMixedList, get, update, and rerun workflow tasks.
run_workflowsMixedRun workflows and check run status.
manage_attachmentsMixedGet, list, create, and update attachments.
manage_sequence_setsMixedList, create, and update sequence sets.
manage_bulk_actionsMixedBulk create, update, and delete objects.
manage_custom_fieldsMixedLists custom field namespaces, types, and fields, and creates or updates custom fields.
manage_decision_tableWriteCreates and updates decision tables.
manage_custom_policiesWriteCreates custom policy drafts for features and entitlements.

Custom Objects, Usage, and E-Invoicing

ToolPermissionDescription
manage_custom_object_definitionsMixedDefine and manage schemas.
manage_custom_object_recordsMixedCreate, read, update, and delete custom object records.
manage_usageMixedUpload, create, update, and query usage records.
manage_mediation_metersMixedRetrieves and validates meters, lists related connections, event stores, and schemas, and creates meters for usage metering.
manage_e_invoicing_configWriteManage service providers, regions, and templates.
manage_e_invoicing_documentsWriteGenerate and sync e-invoices.
manage_commerce_productsWriteCreate, update, and delete commerce products.
manage_commerce_context_attributesMixedLists context attributes and creates or updates attribute values for Dynamic Pricing.
manage_commerce_plansWriteCreates, updates, and deletes commerce plans for Dynamic Pricing.
manage_commerce_chargesMixedQueries, creates, updates, and deletes commerce charges, and updates tier prices for Dynamic Pricing.
manage_omnichannel_subscriptionsMixedManage omnichannel subscriptions.
manage_meters_runMixedProvides run guidance, executes meter runs, tracks run status and history, queries event stores, retrieves run summaries and records, manages prefetch operations, and ingests usage events.
manage_meters_auditMixedProvides audit guidance, retrieves audit trail entries and audit export information, and creates audit exports.