Documentation
record_opening_balance
record_opening_balance MCP tool reference, parameters, return type, and safety hints.
What it does
Records opening balance in the local Clovis ledger.
(account_id: string, amount: number, date: string, status?: string, asset_id?: string | null, counterpart_account_id?: string | null, dry_run?: boolean) => Record<string, unknown>Can write, but supports dry-run. Ask the agent to preview the result before committing changes.
When to use it
Use this section to decide whether the tool fits the user request before calling it.
Before calling
Agents should gather these facts or confirmations first.
Have exact values for required inputs: account_id, amount, date.
Start with dry_run=true, show the preview, then ask before applying the change.
State the intended ledger change in plain language before calling the tool.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
account_idrequiredLedger account id or resolvable account reference.
amountrequiredMoney or quantity amount in the selected asset.
daterequiredLedger date in YYYY-MM-DD format.
statusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "pending"asset_idoptionalAsset or currency id used by the ledger.
Default: nullcounterpart_account_idoptionalOffsetting account used for imported rows or generated transactions.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
record_opening_balance
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "record_opening_balance",
"arguments": {
"account_id": "<account_id>",
"amount": 100,
"date": "2026-06-01"
}
}