Documentation
query_effects
query_effects MCP tool reference, parameters, return type, and safety hints.
What it does
Returns semantic transaction effect lines for income, expenses, balance-sheet movement, transfers, refunds, corrections, and grouped reporting.
(year?: number | null, month?: number | null, date_from?: string | null, date_to?: string | null, status?: string | null, query?: string | null, account_id?: string | null, category_id?: string | null, account_type?: string | null, asset_id?: string | null, group_by?: string, limit?: number, offset?: number, 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.
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: nullstatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "active"queryoptionalCase-insensitive description text to search for.
Default: nullaccount_idoptionalLedger account id or resolvable account reference.
Default: nullcategory_idoptionalIdentifier from the local Clovis ledger.
Default: nullaccount_typeoptionalAccount type filter, such as asset, liability, equity, income, or expense.
Default: nullasset_idoptionalAsset or currency id used by the ledger.
Default: nullgroup_byoptionalOptional grouping: none, journal, status, account, category, description_key, or month.
Default: "none"limitoptionalMaximum number of rows to return.
Default: 100offsetoptionalNumber of rows to skip before returning results.
Default: 0sortoptionalSort 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.
query_effects
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "query_effects",
"arguments": {}
}