Skip to main content

Tools

The server exposes 118 tools across 22 resource families — one for each operation of the REST API. Each tool dispatches in-process to the /v1 endpoint that already implements the operation, so filters, validation, business rules and organization isolation are exactly the API's — the tool is the endpoint.

How to read these pages​

Each tool is listed with four facts:

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

FieldMeaning
read / write / destructiveThe annotation the MCP client reads. A destructive tool (deletes, archives, cancels, reaches the debtor or a third party — a message, a credit bureau, a notary, a webhook —, decides on the debt or rotates a secret) 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.
permissionThe dashboard permission the person who owns the token must hold in the organization.
METHOD /pathThe /v1 endpoint the tool dispatches to, to cross-reference with the API reference.
What it doesThe first sentence of the tool's description, exactly as the model receives it.

Common arguments​

They appear on many tools and always mean the same thing.

ArgumentTypeDescription
pageintegerPage, starting at 1.
per_pageintegerItems per page, at most 100.
sort_bystringSort field, in snake_case (e.g. due_date). A value outside the endpoint's list falls back to the default.
sort_orderasc | descSort direction.
includestringRelations to embed in the response, comma-separated (e.g. person).
idempotency_keystringReplay guard on every write, sent as X-Idempotency-Key.

The catalogue​

FamilyToolsreadwritedestructive
people — Debtors and contact points11443
charges — Charges10325
collection_rules — Collection rules and steps9342
classifications — Classifications5221
templates — Message templates6231
email_layouts — E-mail layouts2110
notifications — Notifications6213
notification_channels — Notification channels5221
notification_preferences — Notification preferences2110
agreements — Agreements10433
negotiation_campaigns — Negotiation campaigns3102
disputes — Disputes4211
tasks — Tasks8251
interactions — Interactions5221
negativations — Credit-bureau reports6204
protests — Protests6204
me — Connection identity1100
metrics — Metrics1100
imports — Imports3210
exports — Exports5410
audit_logs — Audit trail1100
webhook_endpoints — Webhooks9324

A tool you cannot run does not appear in tools/list. If one from this page is missing, see Authentication.