Documentation

create_account

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

npm

What it does

Creates account in the local Clovis ledger.

Signature(name: string, type: string, code?: string, parent_id?: string | null, color_hex?: string, default_asset_id?: string | null, dry_run?: boolean) => Record<string, unknown>
can writedry-run

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.

Use it when an agent needs to prepare a change and show a preview before committing it.
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: name, type.

2

Start with dry_run=true, show the preview, then ask before applying the change.

3

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.

namerequired
string

Human-readable name to create or update.

typerequired
string

Input used by this tool.

codeoptional
string

Input used by this tool.

Default: ""
parent_idoptional
string | null

Parent account id.

Default: null
color_hexoptional
string

Display color for the account or asset.

Default: "#888888"
default_asset_idoptional
string | null

Identifier from the local Clovis ledger.

Default: null

Agent call shape

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

create_account

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

{
  "tool": "create_account",
  "arguments": {
    "name": "<name>",
    "type": "<type>"
  }
}

Metadata