Documentation

audit_categorization

audit_categorization MCP tool reference, parameters, return type, and safety hints.

npm

What it does

Audits categorization in the local Clovis ledger.

Signature(date_from?: string | null, date_to?: string | null, catch_all_account_id?: string | null, min_occurrences?: number, status?: string, mode?: string) => Record<string, unknown>
read-only

Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.

When to use it

Use this section to decide whether the tool fits the user request before calling it.

Use it when an agent needs to inspect the ledger or answer a question without changing records.
Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows.

Before calling

Agents should gather these facts or confirmations first.

1

No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.

Parameters

Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.

date_fromoptional
string | null

Start date filter in YYYY-MM-DD format.

Default: null
date_tooptional
string | null

End date filter in YYYY-MM-DD format.

Default: null
catch_all_account_idoptional
string | null

Fallback category account for rows that do not match a rule.

Default: null
min_occurrencesoptional
integer

Minimum repeated occurrences required before a pattern is reported.

Default: 2
statusoptional
string

Transaction status filter or value: posted, pending, planned, or void.

Default: "posted"
modeoptional
string

Workflow mode used by the tool.

Default: "budget"

Agent call shape

Use the exact tool name and pass arguments as structured JSON through the MCP client.

audit_categorization

Copy this shape into agent instructions, evals, or MCP client tests.

{
  "tool": "audit_categorization",
  "arguments": {}
}

Metadata