Documentation

preview_mutation

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

npm

What it does

Previews mutation in the local Clovis ledger.

Signature(tool_name: string, arguments?: Record<string, unknown>) => 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 during statement import, duplicate review, matching, categorization, or reconciliation workflows.

Before calling

Agents should gather these facts or confirmations first.

1

Have exact values for required inputs: tool_name.

Parameters

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

tool_namerequired
string

Input used by this tool.

argumentsoptional
object

Input used by this tool.

Agent call shape

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

preview_mutation

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

{
  "tool": "preview_mutation",
  "arguments": {
    "tool_name": "<tool_name>"
  }
}

Metadata