Skip to main content

Tools

The server exposes 292 tools over 25 resource families. Each one dispatches in-process to the /v1 endpoint that already implements the operation, so filters, validation, upsert matching and tenant isolation are exactly the REST API's — the tool is the endpoint. The one exception, billing_schemas_get, answers locally and is marked as such.

How to read these pages​

Every tool carries four facts, in this order:

billing_invoices_void · destructive · resource invoices · permission invoices.void · POST /v1/invoices/:id/void

FieldMeaning
read / write / destructiveThe annotation the MCP client reads. On a destructive one it asks the user to confirm.
resourceThe resource family of the tool — what groups the tools in these docs.
permissionThe dashboard permission the person who authorized the client must hold in the organization.
METHOD /pathThe /v1 endpoint the tool dispatches to, to cross-reference with the API reference.

Common arguments​

These appear across many tools and always mean the same thing.

ArgumentTypeDescription
pageinteger1-based page number. Default 1.
per_pageintegerPage size. Default 20, max 100.
sort_bystringSort column, snake_case. billing_schemas_get lists the accepted ones.
sort_orderasc | descDirection. A value that is not a direction is an error, not a silent desc.
fieldsstring[]Columns to return. Omit for the whole resource; id always comes back.
filtersobjectAdditional filters, forwarded verbatim to the endpoint.
idempotency_keystringReplay guard, sent as X-Idempotency-Key.
custom_metadataobjectFree-form JSON owned by you, echoed on every read and webhook.

The catalogue​

FamilyToolsreadwritedestructive
certificates — Digital certificates3201
companies — Issuing companies12462
coupons — Coupons and discount codes8341
credits — Credits7331
customers — Customers and billing accounts19694
invoices — Invoices238114
nfes — Tax invoices (NF-e)248133
payments — Payments and payment methods194114
plan-changes — Plan changes11641
plans — Plans, prices and groups205123
portal-users — Portal users9441
products — Products and product groups244173
proposals — Proposals257117
roles — Team roles6231
services — Service items6231
settings — Organization and schemas3210
subscription-changes — Subscription changes5311
subscriptions — Subscriptions16484
tax-periods — Tax periods5221
tax-rules — Tax rules6231
templates — Proposal templates9261
transfer-destinations — Bank accounts and Pix keys11542
usage — Metered usage7430
users — Dashboard users6231
withholdings — Withholdings8251

A tool you cannot run is not listed by tools/list at all. If one from this page is missing, see Authentication.