Documentation
list_transactions
list_transactions MCP tool reference, parameters, return type, and safety hints.
What it does
Lists transactions in the local Clovis ledger.
(account_id?: string | null, category_id?: string | null, asset_id?: string | null, year?: number | null, month?: number | null, date_from?: string | null, date_to?: string | null, status?: string | null, limit?: number, offset?: number, compact?: boolean, 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.
account_idoptionalLedger account id or resolvable account reference.
Default: nullcategory_idoptionalIdentifier from the local Clovis ledger.
Default: nullasset_idoptionalAsset or currency id used by the ledger.
Default: nullyearoptionalFour-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: nullstatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: nulllimitoptionalMaximum number of rows to return.
Default: 50offsetoptionalNumber of rows to skip before returning results.
Default: 0compactoptionalReturns a smaller response shape when true.
Default: trueinclude_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.
list_transactions
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "list_transactions",
"arguments": {}
}