Documentation

delete_budgets

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

npm

What it does

Deletes budgets in the local Clovis ledger.

Signature(accounts?: string[] | null, year?: number | null, month?: number | null, include_overrides?: boolean, 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.

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 prepare a change and show a preview before committing it.
Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning.

Before calling

Agents should gather these facts or confirmations first.

1

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

2

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

3

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

Parameters

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

accountsoptional
string[] | null

Account selected from the local chart of accounts.

Default: null
yearoptional
integer | null

Four-digit year.

Default: null
monthoptional
integer | null

Month number from 1 to 12.

Default: null
include_overridesoptional
boolean

Boolean switch for this workflow.

Default: false

Agent call shape

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

delete_budgets

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

{
  "tool": "delete_budgets",
  "arguments": {}
}

Metadata