Documentation

goal_progress

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

npm

What it does

Runs goal progress in the local Clovis ledger.

Signature(account: string) => Record<string, unknown>
read-only

Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.

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 inspect the ledger or answer a question without changing records.
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.

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.

Agent call shape

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

goal_progress

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

{
  "tool": "goal_progress",
  "arguments": {
    "account": "<account>"
  }
}

Metadata