project_balances

What it does

Projects balances in the local Clovis ledger.

Signature

(through: string, account_ids?: string[] | null, include_goals?: boolean, branch?: string | null, quote_asset_id: string) => Record<string, unknown>

read-only

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.

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

Use it when working with accounts, transactions, balances, registers, or double-entry records.

Before calling

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: through, quote_asset_id.

2

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.

throughrequired

string

Input used by this tool.

account_idsoptional

string[] | null

List of ledger account ids or account references.

Default: null

include_goalsoptional

boolean

Boolean switch for this workflow.

Default: false

branchoptional

string | null

Scenario branch name or id.

Default: null

quote_asset_idrequired

string

Asset 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.

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

{
  "tool": "project_balances",
  "arguments": {
    "through": "<through>",
    "quote_asset_id": "USD"
  }
}

Metadata

CategoryLedger and accounts

ReturnsobjectReturns object from the local ledger.

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