Documentation

backup_status

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

npm

What it does

Shows backup configuration and recent backup state for the local ledger.

Signature() => Record<string, unknown>
read-only

Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.

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 inspect the ledger or answer a question without changing records.
Use it before or after risky operations to back up, inspect, or repair the ledger.

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.

Parameters

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

This tool does not take parameters.

Agent call shape

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

backup_status

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

{
  "tool": "backup_status",
  "arguments": {}
}

Metadata