Tools

O servidor expõe 176 tools sobre 27 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. As exceções, dashboards_schemas_get, dashboards_workspaces_list e dashboards_me, respondem localmente e estão marcadas como tal. Dentro da organização, os dados ficam em workspaces: toda tool de dados aceita um workspace_id opcional.

Como ler estas páginas

Cada tool aparece com quatro fatos, nesta ordem:

dashboards_portal_users_resend_invite · destructive · recurso portal-users · permissão portal-users.update · POST /v1/portal_users/:id/resend

Campo	Significado
read / write / destructive	A anotação que o cliente MCP lê. Uma destructive (exclui, suspende, encerra, desativa, envia e-mail ou convite) 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.
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 dashboards_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 ao endpoint. Não aceita paginação, ordenação (page, per_page, sort_by, sort_order, limit, cursor, sort) nem um filtro que a tool já nomeia — esses vão como argumento nomeado; dentro de filters são recusados com VALIDATION_ERROR.
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
ai-usage — Uso de IA	1	1	0	0
api-keys — Chaves de API	7	2	2	3
assets — Arquivos	7	3	3	1
audit-logs — Auditoria	3	3	0	0
backups — Backups	7	3	1	3
data-purges — Expurgo de dados	2	2	0	0
entities — Entidades	20	10	8	2
events — Eventos	2	2	0	0
exports — Exportações	4	3	1	0
imports — Importações	3	2	0	1
integrations — Fontes de dados	19	5	11	3
maintenance — Manutenção	1	0	0	1
notifications — Notificações	4	2	0	2
portal-builder — Construtor do portal	9	2	3	4
portal-custom-domains — Domínios próprios	5	2	1	2
portal-oauth-providers — Provedores de login	5	1	2	2
portal-settings — Configurações do portal	7	2	3	2
portal-users — Usuários do portal	11	4	2	5
rate-limits — Limites de requisição	1	1	0	0
roles — Papéis do time	6	2	3	1
settings — Organização e schemas	6	4	2	0
templates — Templates de e-mail	15	5	7	3
usage — Consumo	1	1	0	0
users — Usuários do dashboard	10	4	2	4
webhook-deliveries — Entregas de webhook	2	2	0	0
webhooks — Webhooks	9	3	2	4
workspaces — Workspaces	9	5	3	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.