add_match_rule

What it does

Adds match rule in the local Clovis ledger.

Signature(account_id: string, pattern: string, dry_run?: boolean) => Record<string, unknown>

can writedry-run

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

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.

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: account_id, pattern.

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.

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

account_idrequired

string

Ledger account id or resolvable account reference.

patternrequired

string

Text or regular-expression pattern used to match descriptions.

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

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

{
  "tool": "add_match_rule",
  "arguments": {
    "account_id": "<account_id>",
    "pattern": "<pattern>"
  }
}

CategoryImport, review, and reconciliation

ReturnsobjectReturns object from the local ledger.

AliasesNone