Documentation

compare_scenarios

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

What it does

Compares scenarios in the local Clovis ledger.

Signature(as_of_a?: string | null, as_of_b?: string | null, asset_id: string) => 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 when exploring or managing scenario branches separate from posted records.

Agents should gather these facts or confirmations first.

Have exact values for required inputs: asset_id.

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

as_of_aoptional

string | null

Input used by this tool.

Default: null

as_of_boptional

string | null

Input used by this tool.

Default: null

asset_idrequired

string

Asset or currency id used by the ledger.

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": "compare_scenarios",
  "arguments": {
    "asset_id": "USD"
  }
}

CategoryScenarios

ReturnsobjectReturns object from the local ledger.

Aliasesasset -> asset_id