financial_overview

What it does

Returns a compact financial summary for the selected period and quote asset.

Signature(year?: number | null, month?: number | null, status?: string, quote_asset_id: string) => Record<string, unknown>

read-only

Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.

Use this section to decide whether the tool fits the user request before calling it.

Use it when an agent needs to inspect the ledger or answer a question without changing records.

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: quote_asset_id.

2

Choose the report currency or asset explicitly; Clovis does not infer report currency.

Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.

yearoptional

integer | null

Four-digit year.

Default: null

monthoptional

integer | null

Month number from 1 to 12.

Default: null

statusoptional

string

Transaction status filter or value: posted, pending, planned, or void.

Default: "active"

quote_asset_idrequired

string

Asset or currency used to quote report values. Clovis does not infer this.

Use the exact tool name and pass arguments as structured JSON through the MCP client.

Copy this shape into agent instructions, evals, or MCP client tests.

{
  "tool": "financial_overview",
  "arguments": {
    "quote_asset_id": "USD"
  }
}

CategoryCore tools

ReturnsobjectReturns object from the local ledger.

Aliasescurrency -> quote_asset_id, quote -> quote_asset_id, quote_id -> quote_asset_id