Documentation

preview_commit

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

What it does

Previews commit in the local Clovis ledger.

Signature(as_of?: string | null) => Record<string, unknown>

read-only

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

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.

Agents should gather these facts or confirmations first.

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

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

as_ofoptional

string | null

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

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": "preview_commit",
  "arguments": {}
}

CategoryImport, review, and reconciliation

ReturnsobjectReturns object from the local ledger.

AliasesNone