Documentation

discard_branch

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

What it does

Discards scenario branch in the local Clovis ledger.

Signature(name: string, dry_run?: boolean) => Record<string, unknown>

can writedry-rundestructive

Destructive. This can remove, void, discard, roll back, repair, or permanently change ledger data. Require explicit user approval.

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 when exploring or managing scenario branches separate from posted records.

Agents should gather these facts or confirmations first.

Have exact values for required inputs: name.

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

Create or confirm a backup and get explicit approval before running it for real.

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

namerequired

string

Human-readable name to create or update.

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

CategoryScenarios

ReturnsobjectReturns object from the local ledger.

AliasesNone