close_period

What it does

Closes period in the local Clovis ledger.

Signature(name: string, as_of: string, description?: 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.

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.

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: name, as_of.

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.

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.

as_ofrequired

string

Date to calculate balances through, usually YYYY-MM-DD.

descriptionoptional

string | null

Human-readable transaction, account, rule, or journal description.

Default: null

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": "close_period",
  "arguments": {
    "name": "<name>",
    "as_of": "2026-06-01"
  }
}

CategoryCore tools

ReturnsobjectReturns object from the local ledger.

AliasesNone