Documentation

reconcile_planned

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

npm

What it does

Reconciles planned in the local Clovis ledger.

Signature(year?: number | null, month?: number | null, date_from?: string | null, date_to?: string | null, account_id?: string | null, account_ids?: string[] | null, asset_id?: string | null, date_tolerance_days?: number, dry_run?: boolean) => Record<string, unknown>
can writedry-rundestructive

Destructive. This can remove, void, discard, roll back, repair, or permanently change ledger data. Require explicit user approval.

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

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

2

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

3

Create or confirm a backup and get explicit approval before running it for real.

Parameters

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

yearoptional
integer | null

Four-digit year.

Default: null
monthoptional
integer | null

Month number from 1 to 12.

Default: null
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
account_idoptional
string | null

Ledger account id or resolvable account reference.

Default: null
account_idsoptional
string[] | null

List of ledger account ids or account references.

Default: null
asset_idoptional
string | null

Asset or currency id used by the ledger.

Default: null
date_tolerance_daysoptional
integer

Number of days a candidate match may differ by.

Default: 3
dry_runoptional
boolean

Preview the result without committing changes.

Default: true

Agent call shape

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

reconcile_planned

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

{
  "tool": "reconcile_planned",
  "arguments": {
    "dry_run": true
  }
}

Metadata