Documentation

match_transfer_pairs

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

npm

What it does

Matches transfer pairs in the local Clovis ledger.

Signature(clearing_account?: string | null, account_a?: string | null, account_b?: string | null, date_from?: string | null, date_to?: string | null, date_tolerance_days?: number, match_by?: 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.

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

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.

clearing_accountoptional
string | null

Account selected from the local chart of accounts.

Default: null
account_aoptional
string | null

Account selected from the local chart of accounts.

Default: null
account_boptional
string | null

Account selected from the local chart of accounts.

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
date_tolerance_daysoptional
integer

Number of days a candidate match may differ by.

Default: 0
match_byoptional
string

Input used by this tool.

Default: "amount+date+code"
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.

match_transfer_pairs

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

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

Metadata