get_roadmap_comments

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

Discloses return structure (array with author, body, timestamp) and failure behavior (roadmap_id not found) beyond annotations (readOnlyHint, idempotentHint), with no contradictions.

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?

Four sentences arranged logically with clear sections (purpose, usage, return, failure). Every sentence conveys distinct useful information without redundancy.

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?

For a simple read tool with one parameter, the description covers purpose, usage, return format, and failure mode. Annotations provide readOnly and idempotent hints, and no output schema is needed given the explicit return description.

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 covers roadmap_id 100%, but description adds value by linking the parameter to the failure case and suggesting list_roadmaps for finding valid IDs, enhancing agent understanding.

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?

Clearly states it gets roadmap-level comments, specifically distinguishes from 'bar comments' (sibling get_bar_comments), with verb 'Get' and resource 'roadmap-level comments'.

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?

Explicit 'USE WHEN' directive with example phrases, states when NOT to use and the alternative tool (get_bar_comments), and notes failure condition with suggested fix (use list_roadmaps).

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