Documentation

delete_goal

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

What it does

Deletes goal in the local Clovis ledger.

Signature(account: 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 for budgets, goals, forecasts, month-end projections, runway, or cash planning.

Agents should gather these facts or confirmations first.

Have exact values for required inputs: account.

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.

accountrequired

string

Account name or id to inspect.

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

CategoryPlanning and cash flow

ReturnsobjectReturns object from the local ledger.

AliasesNone