roadmap_update

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

No annotations exist, so full burden on description. It discloses that notes are appended, but does not mention persistence, authorization, or error conditions (e.g., invalid item ID). Adequate but not thorough.

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

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

Two sentences, front-loaded with verb and resource, every sentence earns its place. No redundancy or fluff.

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

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

Covers main actions and lifecycle, but with 7 parameters and no output schema, it omits details on optional parameter behavior (e.g., partial updates) and potential errors. Adequate for typical usage.

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

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

Schema coverage is 100%, baseline 3. Description adds value by explaining the lifecycle context for the status parameter. Other parameters are well-described in schema; description does not add much beyond.

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

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

The description clearly states 'Update the status, priority, or details of a roadmap item' and specifies the lifecycle transitions (planned → in-progress → done/blocked/cancelled). It effectively distinguishes from siblings like roadmap_add and roadmap_list.

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

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

Provides clear usage context: moving items through lifecycle and adding notes. However, lacks explicit when-not-to-use or comparison with alternative tools (e.g., roadmap_next).

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