Tools

O servidor expõe 118 tools sobre 22 famílias de recurso — uma para cada operação da API REST. Cada tool despacha in-process para o endpoint de /v1 que já implementa a operação, então filtros, validação, regras de negócio e isolamento por organização são exatamente os da API — a tool é o endpoint.

Como ler estas páginas

Cada tool aparece com quatro informações:

dunning_charges_notify · destructive · charges.notify · POST /v1/charges/{id}/notify

Campo	Significado
read / write / destructive	A anotação que o cliente MCP lê. Uma destructive (apaga, arquiva, cancela, fala com o devedor ou com terceiro — mensagem, bureau, cartório, webhook —, decide sobre a dívida ou rotaciona segredo) só roda depois de o usuário confirmar no formulário que o servidor envia, na revisão 2026-07-28; cliente que não consegue confirmar recebe confirmation_required.
permissão	A permissão de dashboard que a pessoa dona do token 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.
O que faz	A primeira frase da description da tool, em inglês, exatamente como o modelo a recebe.

Argumentos comuns

Aparecem em muitas tools e significam sempre a mesma coisa.

Argumento	Tipo	Descrição
page	inteiro	Página, a partir de 1.
per_page	inteiro	Itens por página, no máximo 100.
sort_by	string	Campo de ordenação, em snake_case (ex.: due_date). Valor fora da lista do endpoint cai no padrão.
sort_order	asc | desc	Direção da ordenação.
include	string	Relações a embutir na resposta, separadas por vírgula (ex.: person).
idempotency_key	string	Proteção contra repetição em toda escrita, enviada como X-Idempotency-Key.

O catálogo

Família	Tools	read	write	destructive
people — Devedores e pontos de contato	11	4	4	3
charges — Cobranças	10	3	2	5
collection_rules — Réguas de cobrança e passos	9	3	4	2
classifications — Classificações	5	2	2	1
templates — Modelos de mensagem	6	2	3	1
email_layouts — Layouts de e-mail	2	1	1	0
notifications — Notificações	6	2	1	3
notification_channels — Canais de notificação	5	2	2	1
notification_preferences — Preferências de notificação	2	1	1	0
agreements — Acordos	10	4	3	3
negotiation_campaigns — Campanhas de negociação	3	1	0	2
disputes — Disputas	4	2	1	1
tasks — Tarefas	8	2	5	1
interactions — Interações	5	2	2	1
negativations — Negativações	6	2	0	4
protests — Protestos	6	2	0	4
me — Identidade da conexão	1	1	0	0
metrics — Indicadores	1	1	0	0
imports — Importações	3	2	1	0
exports — Exportações	5	4	1	0
audit_logs — Trilha de auditoria	1	1	0	0
webhook_endpoints — Webhooks	9	3	2	4

Uma tool que você não pode rodar não aparece em tools/list. Se faltar alguma desta página, veja Autenticação.