This article lists all currently supported tools available through the Maxio Model Context Protocol (MCP). These tools are grouped by platform and describe their capabilities for data access, report generation, and workflow automation.
Analyst Role (Recommended: Read-Only)
The Analyst role is designed for safe data access, reporting, and analysis. It includes only read operations and does not allow data creation or modification.
- All Maxio (General) tools
- All Advanced Billing read tools
- All Maxio Core read tools
Best for: Reporting, analysis, auditing, and customer support workflows.
Bookkeeper Role (Recommended: Read + Create)
The Bookkeeper role includes everything in the Analyst role, plus the ability to create and manage billing and transaction data.
- All Analyst tools
- Advanced Billing create tools:
- Create Component
- Create Coupon
- Create Customers
- Create Product Family
- Create Product
- Create Subscription
- Maxio Core create tools:
Best for: Finance, billing operations, and workflow execution.
Maxio (General)
- About Current Account: Returns Advanced Billing and Maxio Core endpoints along with key account metadata to provide context for other tool calls.
- Create Component: Creates a quantity-based component within the product catalog, supporting tiered pricing and schemes.
- Create Coupon: Builds percentage- or amount-based coupons scoped to product families, with optional restrictions.
- Create Customers: Accepts an array of customer payloads to bulk-create records, with per-record error handling.
- Create Product Family: Registers a new product family container to organize related products and components.
- Create Product: Adds a new product to a family with interval, pricing, trial, and accounting metadata.
- Create Subscription: Provisions a subscription (remittance only) using customer, pricing, coupon, and component options under PCI-safe constraints.
- List Advanced Billing Subscriptions: Returns a paginated, filterable list of subscriptions by state, product, or price point.
- Search Customer by Reference: Looks up a Customer using an external reference ID and enriches the result with custom fields and Subscriptions.
- Show Advanced Billing Customers: Retrieves Customer records (optionally by ID or query), including Subscriptions and custom fields.
- Show Product Catalog: Aggregates the full product catalog, including families, products, components, coupons, and site metadata.
- Show Advanced Billing Subscriptions: Retrieves detailed subscription records (by ID), including payment profiles, custom fields, Invoices, and components.
- Create Sales Order in Maxio Core: Creates a sales order and nested line items in Maxio Core for downstream billing and revenue workflows.
- Download Existing Report Run: Pulls a previously run report using a report run ID. Returns either CSV data or a secure download link.
- Generate Maxio One Click Report: Runs a selected report, waits for export, downloads the CSV, and renders the data.
- List Reports (search): Lists available Maxio report definitions, including IDs, names, descriptions, and URLs for downstream usage.
- Fetch Report: Generates a selected Maxio report using the GenerateReportTool and returns its contents by ID.
- List Maxio Core Contracts: Lists contracts with pagination and filters (Customer, register, Maxio ID) with register preloading.
- List Maxio Core Customers: Paginates Customers or retrieves specific IDs, returning authoritative records.
- List Maxio Core Invoices: Returns Invoices with pagination and filters for Customer, contract, or register.
- List Maxio Core Payments: Lists payments, refunds, or credits filtered by type, Customer, source, currency, and contract.
- Listing Maxio Projects: Returns all Maxio Project objects configured for the current account.
- Listing Maxio Reports: Outputs all report definitions and IDs required for triggering report generation.
- List Maxio Core Sales Orders: Paginates sales orders, filters by creation date, and excludes integration-specific fields.
- List Maxio Core Transactions: Retrieves Transactions by Customer, contract, item, or register with preloaded metadata.
- Retrieve Maxio Core Contract Details: Combines contract metadata, analytics, and register data into one view.
- Retrieve Customer Details: Returns a comprehensive Customer dashboard with analytics, contracts, Invoices, Transactions, and payments.
- Retrieve Maxio Core Invoice Details: Provides enriched Invoice data, including item-level details.
- Retrieving Project with Details: Outputs a project and associated milestones and triggers for workflow analysis.
See Also: Example Prompts for Maxio MCP Tools
Still need help?
Reach out and our support team will take it from here.
Contact support