Documentation
search_transactions
search_transactions MCP tool reference, parameters, return type, and safety hints.
What it does
Searches transactions in the local Clovis ledger.
(desc?: string | null, query?: string | null, amount_min?: number | null, amount_max?: number | null, account_id?: string | null, status?: string | null, date_from?: string | null, date_to?: string | null, posted_at_from?: string | null, posted_at_to?: string | null, limit?: number, offset?: number, include_account_effects?: boolean, sort?: string) => 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.
descoptionalInput used by this tool.
Default: nullqueryoptionalCase-insensitive description text to search for.
Default: nullamount_minoptionalMoney or quantity value in the relevant asset.
Default: nullamount_maxoptionalMoney or quantity value in the relevant asset.
Default: nullaccount_idoptionalLedger account id or resolvable account reference.
Default: nullstatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: nulldate_fromoptionalStart date filter in YYYY-MM-DD format.
Default: nulldate_tooptionalEnd date filter in YYYY-MM-DD format.
Default: nullposted_at_fromoptionalInput used by this tool.
Default: nullposted_at_tooptionalInput used by this tool.
Default: nulllimitoptionalMaximum number of rows to return.
Default: 50offsetoptionalNumber of rows to skip before returning results.
Default: 0include_account_effectsoptionalAccount selected from the local chart of accounts.
Default: falsesortoptionalSort order for returned rows.
Default: "date_desc"Agent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
search_transactions
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "search_transactions",
"arguments": {}
}