Documentation
find_realized_planned
find_realized_planned MCP tool reference, parameters, return type, and safety hints.
What it does
Finds realized planned in the local Clovis ledger.
(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) => Record<string, unknown>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.
Before calling
Agents should gather these facts or confirmations first.
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.
yearoptionalFour-digit year.
Default: nullmonthoptionalMonth number from 1 to 12.
Default: nulldate_fromoptionalStart date filter in YYYY-MM-DD format.
Default: nulldate_tooptionalEnd date filter in YYYY-MM-DD format.
Default: nullaccount_idoptionalLedger account id or resolvable account reference.
Default: nullaccount_idsoptionalList of ledger account ids or account references.
Default: nullasset_idoptionalAsset or currency id used by the ledger.
Default: nulldate_tolerance_daysoptionalNumber of days a candidate match may differ by.
Default: 3Agent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
find_realized_planned
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "find_realized_planned",
"arguments": {}
}