Documentation

get_balance

get_balance MCP tool reference, parameters, return type, and safety hints.

npm

What it does

Shows balance in the local Clovis ledger.

Signature(account_id: string, asset_id?: string | null, date?: string | null, status?: 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: account_id.

Parameters

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.

asset_idoptional
string | null

Asset or currency id used by the ledger.

Default: null
dateoptional
string | null

Ledger date in YYYY-MM-DD format.

Default: null
statusoptional
string

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

Default: "posted"

Agent call shape

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

get_balance

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

{
  "tool": "get_balance",
  "arguments": {
    "account_id": "<account_id>"
  }
}

Metadata