Skip to main content

Tools

The server exposes 176 tools over 27 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 exceptions, dashboards_schemas_get, dashboards_workspaces_list and dashboards_me, answer locally and are marked as such. Inside the organization, data lives in workspaces: every data tool takes an optional workspace_id.

How to read these pages​

Every tool carries four facts, in this order:

dashboards_portal_users_resend_invite · destructive · resource portal-users · permission portal-users.update · POST /v1/portal_users/:id/resend

FieldMeaning
read / write / destructiveThe annotation the MCP client reads. A destructive tool (deletes, suspends, closes, deactivates, sends an e-mail or invite) runs only after the user confirms in the form the server sends, on revision 2026-07-28; a client that cannot confirm gets confirmation_required.
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. dashboards_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 to the endpoint. Does not take pagination, sorting (page, per_page, sort_by, sort_order, limit, cursor, sort) or a filter the tool already names — pass those as named arguments; inside filters they are refused with VALIDATION_ERROR.
idempotency_keystringReplay guard, sent as X-Idempotency-Key.
custom_metadataobjectFree-form JSON owned by you, echoed on every read and webhook.

The catalogue​

FamilyToolsreadwritedestructive
ai-usage — AI usage1100
api-keys — API keys7223
assets — Assets7331
audit-logs — Audit log3300
backups — Backups7313
data-purges — Data purge2200
entities — Entities201082
events — Events2200
exports — Exports4310
imports — Imports3201
integrations — Data sources195113
maintenance — Maintenance1001
notifications — Notifications4202
portal-builder — Portal builder9234
portal-custom-domains — Custom domains5212
portal-oauth-providers — Sign-in providers5122
portal-settings — Portal settings7232
portal-users — Portal users11425
rate-limits — Rate limits1100
roles — Team roles6231
settings — Organization and schemas6420
templates — E-mail templates15573
usage — Usage1100
users — Dashboard users10424
webhook-deliveries — Webhook deliveries2200
webhooks — Webhooks9324
workspaces — Workspaces9531

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