backup_now

What it does

Creates a local backup of the selected Clovis ledger.

Signature(output_path?: string | null, compact?: boolean, 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 before or after risky operations to back up, inspect, or repair the ledger.

Use it only for local files the user has intentionally made available to Clovis.

Before calling

Agents should gather these facts or confirmations first.

1

No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.

2

Confirm the file path, permissions, and whether the agent is allowed to read or write that location.

3

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

4

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.

output_pathoptional

string | null

Local output path for a generated file or backup.

Default: null

compactoptional

boolean

Returns a smaller response shape when true.

Default: false

dry_runoptional

boolean

Preview the result without committing changes.

Default: false

Agent call shape

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": "backup_now",
  "arguments": {
    "dry_run": true
  }
}

Metadata

CategoryMaintenance and safety

ReturnsobjectReturns object from the local ledger.

AliasesNone