assert_balance

What it does

Checks balance in the local Clovis ledger.

Signature

(account_id: string, expected: number, date?: string | null, asset_id?: string | null, status?: string | null) => 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.

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

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: account_id, expected.

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

account_idrequired

string

Ledger account id or resolvable account reference.

expectedrequired

number

Expected balance amount to compare with the ledger.

dateoptional

string | null

Ledger date in YYYY-MM-DD format.

Default: null

asset_idoptional

string | null

Asset or currency id used by the ledger.

Default: null

statusoptional

string | null

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

Default: null

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": "assert_balance",
  "arguments": {
    "account_id": "<account_id>",
    "expected": 1
  }
}

CategoryLedger and accounts

ReturnsobjectReturns object from the local ledger.

Aliasesasset -> asset_id