Skip to main content

Tools

The server exposes 95 tools over 20 resource families. Each one dispatches in-process to the /v1 endpoint that already implements the operation, so filters, validation, settlement rules and workspace isolation are exactly the REST API's — the tool is the endpoint. The exceptions, finance_schemas_get (the published contract) and finance_workspaces_list (the workspaces the person can reach), answer locally. Every other tool takes workspace_id.

How to read these pages​

Every tool carries four facts:

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

FieldMeaning
read / write / destructiveThe annotation the MCP client reads. A destructive one runs only after the server asks the person to confirm — a client that cannot ask gets confirmation_required. See Confirming destructive tools.
permissionThe permission the token's person must hold in the organization — the same the action requires in the dashboard.
METHOD /pathThe /v1 endpoint the tool dispatches to, to cross-reference with the API reference. The token needs the scope that endpoint requires.

Common arguments​

These appear across many tools and always mean the same thing.

ArgumentTypeDescription
limitintegerPage size. Default 25, max 100 (10000 on the *_ids tools).
cursorstringThe previous page's meta.next_cursor. null there means the last page.
filtersobjectThe filters the listing accepts: a scalar is equality, an array is in, an object picks operators ({ "gte": …, "lt": … }).
sort_byenumSort column, among the ones the listing accepts.
sort_orderasc | descDirection. Default asc.
fieldsstring[]Columns to return. Omit for the whole record; id always comes back.
idempotency_keystringReplay guard, sent as X-Idempotency-Key. Required on the money-moving actions.
custom_metadataobjectFree-form JSON owned by you, echoed on every read.

The catalogue​

FamilyToolsreadwritedestructive
payables — Payables9423
receivables — Receivables9423
financial_transactions — Transactions7421
transfers — Transfers2101
reconciliations — Reconciliations3102
receipts — Receipts2200
financial_accounts — Financial accounts and balances10433
banks — Banks1100
cash_flow — Cash flow1100
companies — Companies5221
people — People6321
categories — Categories5221
classification_centers — Classification centers5221
custom_classifiers — Custom classifiers8242
taxes — Taxes5221
automatic_rules — Automatic rules6231
attachments — Attachments7322
fiscal_documents — Received fiscal documents2200
schemas — Field catalogue1100
workspaces — Workspaces1100

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