Documentation

reopen_period

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

npm

What it does

Reopens period in the local Clovis ledger.

Signature(checkpoint_id: string, 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.

Before calling

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: checkpoint_id.

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.

checkpoint_idrequired
string

Period checkpoint id to reopen.

Agent call shape

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

reopen_period

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

{
  "tool": "reopen_period",
  "arguments": {
    "checkpoint_id": "<checkpoint_id>"
  }
}

Metadata