Documentation
budget_status
budget_status MCP tool reference, parameters, return type, and safety hints.
What it does
Shows budget status in the local Clovis ledger.
(account?: string | null, year?: number | null, month?: number | null, rollup?: boolean, include_pending?: boolean, status?: string, quote_asset_id: 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.
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.
accountoptionalAccount name or id to inspect.
Default: nullyearoptionalFour-digit year.
Default: nullmonthoptionalMonth number from 1 to 12.
Default: nullrollupoptionalBoolean switch for this workflow.
Default: falseinclude_pendingoptionalIncludes pending transactions in the calculation.
Default: falsestatusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "posted"quote_asset_idrequiredAsset or currency used to quote report values. Clovis does not infer this.
Agent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
budget_status
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "budget_status",
"arguments": {
"quote_asset_id": "USD"
}
}