Skip to main content
Glama

refine_plan

Modify an existing forecasting plan by changing selected decisions, producing a new plan id while preserving the original plan.

Instructions

Build a new plan from an existing one, changing some of its decisions. Returns a new plan id; the original plan is kept.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
plan_idYesId of the plan to refine.
overridesYesValues to change, e.g. {'estimator': 'Ridge', 'lags': 12}. An omitted key keeps the value of the plan; {'lags': null} selects the lags again and {'interval': null} removes the interval.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
costNo
kindYes
filesNo
linksNo
noticesNo
summaryYes
changeableNo
notices_omittedNo
values_includedNo
summary_truncatedNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false and destructiveHint=false, and the description usefully adds that the operation is non-destructive: it returns a new plan id and leaves the original intact. It does not mention validation failure modes (e.g. incompatible overrides) or any cost, but the key mutation semantics are disclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with zero waste, and the return/immutability fact is front-loaded alongside the purpose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return values need no elaboration, and the description still notes that a new plan id is returned. For a tool whose override semantics live in the schema, this is nearly complete; only guidance on choosing between refine_plan and plan is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the $defs go into deep detail on each override, including null/omitted semantics, so the schema carries the burden. The description adds nothing parameter-specific beyond the example in the schema itself; baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource+scope: building a new plan derived from an existing one by changing decisions. This implicitly separates it from the `plan` sibling (which builds from scratch), though no sibling is named explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied by 'from an existing one' — the agent can infer this is the tool for modifying an already-created plan rather than creating a fresh one, but there is no explicit when-to-use/when-not guidance or reference to `plan`/`forecast` alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.