Tools

O servidor expõe 95 tools sobre 20 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 baixa e isolamento por workspace são exatamente os da API REST — a tool é o endpoint. As exceções, finance_schemas_get (o contrato publicado) e finance_workspaces_list (os espaços que a pessoa alcança), respondem localmente. Toda outra tool aceita workspace_id.

Como ler estas páginas

Cada tool aparece com quatro fatos:

finance_payables_send_to_bank · destructive · permissão payables.dispatch · POST /v1/payables/{id}/send-to-bank

Campo	Significado
read / write / destructive	A anotação que o cliente MCP lê. Uma destructive só roda depois que o servidor pede confirmação à pessoa — um cliente que não pode perguntar recebe confirmation_required. Veja Confirmação de tools destrutivas.
permissão	A permissão que a pessoa do token precisa ter na organização — a mesma que a ação exige no dashboard.
MÉTODO /caminho	O endpoint de /v1 para onde a tool despacha, para cruzar com a Referência da API. O token precisa do escopo que esse endpoint exige.

Argumentos comuns

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

Argumento	Tipo	Descrição
limit	inteiro	Tamanho da página. Padrão 25, máximo 100 (10000 nas tools *_ids).
cursor	string	O meta.next_cursor da página anterior. null lá significa a última página.
filters	object	Os filtros que a listagem aceita: escalar é igualdade, array é in, objeto escolhe operadores ({ "gte": …, "lt": … }).
sort_by	enum	Coluna de ordenação, entre as que a listagem aceita.
sort_order	asc | desc	Direção. Padrão asc.
fields	string[]	Colunas a devolver. Omitido, volta o registro inteiro; id sempre volta.
idempotency_key	string	Proteção contra repetição, enviada como X-Idempotency-Key. Obrigatória nas ações que movem dinheiro.
custom_metadata	object	JSON livre seu, devolvido em toda leitura.

O catálogo

Família	Tools	read	write	destructive
payables — Contas a pagar	9	4	2	3
receivables — Contas a receber	9	4	2	3
financial_transactions — Lançamentos	7	4	2	1
transfers — Transferências	2	1	0	1
reconciliations — Conciliações	3	1	0	2
receipts — Comprovantes	2	2	0	0
financial_accounts — Contas financeiras e saldos	10	4	3	3
banks — Bancos	1	1	0	0
cash_flow — Fluxo de caixa	1	1	0	0
companies — Empresas	5	2	2	1
people — Pessoas	6	3	2	1
categories — Categorias	5	2	2	1
classification_centers — Centros de classificação	5	2	2	1
custom_classifiers — Classificadores personalizados	8	2	4	2
taxes — Impostos	5	2	2	1
automatic_rules — Regras automáticas	6	2	3	1
attachments — Anexos	7	3	2	2
fiscal_documents — Notas fiscais recebidas	2	2	0	0
schemas — Catálogo de campos	1	1	0	0
workspaces — Espaços	1	1	0	0

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