Documentation
financial_picture
financial_picture MCP tool reference, parameters, return type, and safety hints.
What it does
Returns a broader snapshot of balances, spending, pending items, and planned activity.
(year?: number | null, month?: number | null, quote_asset_id: string, status?: string | null, include_pending?: boolean, include_planned?: boolean, entity_id?: string | null, account_ids?: string[] | null, asset_account_ids?: string[] | null, liability_account_ids?: string[] | null, earmarks?: Array<Record<string, unknown>> | null, include_open_items?: boolean, open_item_limit?: number, include_summary_markdown?: boolean) => 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.
Have exact values for required inputs: quote_asset_id.
Choose the report currency or asset explicitly; Clovis does not infer report currency.
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: nullquote_asset_idrequiredAsset or currency used to quote report values. Clovis does not infer this.
statusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: nullinclude_pendingoptionalIncludes pending transactions in the calculation.
Default: trueinclude_plannedoptionalIncludes planned transactions in the calculation.
Default: falseentity_idoptionalEntity id to filter reports when entity tracking is used.
Default: nullaccount_idsoptionalList of ledger account ids or account references.
Default: nullasset_account_idsoptionalAsset account ids to include in a projection.
Default: nullliability_account_idsoptionalList of identifiers from the local Clovis ledger.
Default: nullearmarksoptionalInput used by this tool.
Default: nullinclude_open_itemsoptionalBoolean switch for this workflow.
Default: trueopen_item_limitoptionalNumeric value used by this workflow.
Default: 25include_summary_markdownoptionalBoolean switch for this workflow.
Default: falseAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
financial_picture
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "financial_picture",
"arguments": {
"quote_asset_id": "USD"
}
}