Documentation

recategorize_by_patterns

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

npm

What it does

Recategorizes by patterns in the local Clovis ledger.

Signature(rules: Array<Record<string, unknown>>, date_from?: string | null, date_to?: string | null, dry_run?: boolean, persist_rules?: boolean, old_account_id?: string | null, verbose?: boolean, status?: string, amount_min?: number | null, amount_max?: number | null) => Record<string, unknown>
can writedry-run

Can write, but supports dry-run. Ask the agent to preview the result before committing changes.

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 prepare a change and show a preview before committing it.
Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows.

Before calling

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: rules.

2

Start with dry_run=true, show the preview, then ask before applying the change.

3

State the intended ledger change in plain language before calling the tool.

Parameters

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

rulesrequired
object[]

Match rules to create or apply.

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
dry_runoptional
boolean

Preview the result without committing changes.

Default: true
persist_rulesoptional
boolean

Boolean switch for this workflow.

Default: false
old_account_idoptional
string | null

Identifier from the local Clovis ledger.

Default: null
verboseoptional
boolean

Boolean switch for this workflow.

Default: false
statusoptional
string

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

Default: "posted"
amount_minoptional
integer | null

Money or quantity value in the relevant asset.

Default: null
amount_maxoptional
integer | null

Money or quantity value in the relevant asset.

Default: null

Agent call shape

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

recategorize_by_patterns

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

{
  "tool": "recategorize_by_patterns",
  "arguments": {
    "rules": [],
    "dry_run": true
  }
}

Metadata