Documentation

assert_balances

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

npm

What it does

Checks balances in the local Clovis ledger.

Signature(assertions: unknown[], status?: string | null) => 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: assertions.

Parameters

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

assertionsrequired
array

Balance assertions to check against the ledger.

statusoptional
string | null

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

Default: null

Agent call shape

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

assert_balances

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

{
  "tool": "assert_balances",
  "arguments": {
    "assertions": []
  }
}

Metadata