Documentation

get_account_by_name

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

What it does

Shows account by name in the local Clovis ledger.

Signature(name: string) => Record<string, unknown> | null

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.

Have exact values for required inputs: name.

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

namerequired

string

Human-readable name to create or update.

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": "get_account_by_name",
  "arguments": {
    "name": "<name>"
  }
}

CategoryLedger and accounts

ReturnsobjectReturns object from the local ledger.

AliasesNone