Documentation

set_budgets

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

npm

What it does

Sets budgets in the local Clovis ledger.

Signature(budgets: Array<Record<string, unknown>>, year?: number | null, month?: number | null, dry_run?: boolean) => Record<string, unknown>
can writedry-run

Can write, but supports dry-run. Ask the agent to preview the result before committing changes.

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

Have exact values for required inputs: budgets.

2

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

3

State the intended ledger change in plain language before calling the tool.

Parameters

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

budgetsrequired
object[]

Input used by this tool.

yearoptional
integer | null

Four-digit year.

Default: null
monthoptional
integer | null

Month number from 1 to 12.

Default: null

Agent call shape

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

set_budgets

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

{
  "tool": "set_budgets",
  "arguments": {
    "budgets": []
  }
}

Metadata