set_goal

What it does

Sets goal in the local Clovis ledger.

Signature

(account: string, target: number, name: string, target_date?: string | null, priority?: number, asset_id?: string | 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: account, target, name.

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.

accountrequired

string

Account name or id to inspect.

targetrequired

number

Numeric value used by this workflow.

namerequired

string

Human-readable name to create or update.

target_dateoptional

string | null

Date value, usually in YYYY-MM-DD format.

Default: null

priorityoptional

integer

Numeric value used by this workflow.

Default: 1

asset_idoptional

string | null

Asset or currency id used by the ledger.

Default: null

Agent call shape

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": "set_goal",
  "arguments": {
    "account": "<account>",
    "target": 1,
    "name": "<name>"
  }
}

Metadata

CategoryPlanning and cash flow

ReturnsobjectReturns object from the local ledger.

Aliasesasset -> asset_id