Tools

O servidor expõe 292 tools sobre 25 famílias de recurso. Cada uma despacha in-process para o endpoint de /v1 que já implementa a operação, então filtros, validação, regras de upsert e isolamento por organização são exatamente os da API REST — a tool é o endpoint. A única exceção, billing_schemas_get, responde localmente e está marcada como tal.

Como ler estas páginas

Cada tool aparece com quatro fatos, nesta ordem:

billing_invoices_void · destructive · recurso invoices · permissão invoices.void · POST /v1/invoices/:id/void

Campo	Significado
read / write / destructive	A anotação que o cliente MCP lê. Numa destructive ele pede confirmação ao usuário.
recurso	A família de recurso da tool — o que agrupa as tools nesta documentação.
permissão	A permissão de dashboard que a pessoa que autorizou o cliente precisa ter na organização.
MÉTODO /caminho	O endpoint de /v1 para onde a tool despacha, para cruzar com a Referência da API.

Argumentos comuns

Estes aparecem em muitas tools e significam sempre a mesma coisa.

Argumento	Tipo	Descrição
page	inteiro	Página, a partir de 1. Padrão 1.
per_page	inteiro	Itens por página. Padrão 20, máximo 100.
sort_by	string	Coluna de ordenação, em snake_case. Os aceitos estão em billing_schemas_get.
sort_order	asc | desc	Direção. Um valor que não é direção é erro, não um desc silencioso.
fields	string[]	Colunas a devolver. Omitido, volta o recurso inteiro; id sempre volta.
filters	object	Filtros adicionais, repassados verbatim ao endpoint.
idempotency_key	string	Proteção contra replay, enviada como X-Idempotency-Key.
custom_metadata	object	JSON livre seu, devolvido em toda leitura e em todo webhook.

O catálogo

Família	Tools	read	write	destructive
certificates — Certificados digitais	3	2	0	1
companies — Empresas emissoras	12	4	6	2
coupons — Cupons e códigos de desconto	8	3	4	1
credits — Créditos	7	3	3	1
customers — Clientes e contas de cobrança	19	6	9	4
invoices — Faturas	23	8	11	4
nfes — Notas fiscais (NF-e)	24	8	13	3
payments — Pagamentos e métodos de pagamento	19	4	11	4
plan-changes — Mudanças de plano	11	6	4	1
plans — Planos, preços e grupos	20	5	12	3
portal-users — Usuários do portal	9	4	4	1
products — Produtos e grupos de produtos	24	4	17	3
proposals — Propostas	25	7	11	7
roles — Papéis do time	6	2	3	1
services — Itens de serviço	6	2	3	1
settings — Organização e schemas	3	2	1	0
subscription-changes — Mudanças de assinatura	5	3	1	1
subscriptions — Assinaturas	16	4	8	4
tax-periods — Períodos de apuração	5	2	2	1
tax-rules — Regras fiscais	6	2	3	1
templates — Templates de proposta	9	2	6	1
transfer-destinations — Contas bancárias e chaves Pix	11	5	4	2
usage — Consumo medido	7	4	3	0
users — Usuários do dashboard	6	2	3	1
withholdings — Retenções	8	2	5	1

Uma tool que você não pode rodar não aparece em tools/list. Se uma daqui não está lá, veja Autenticação.