get_roadmap

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

Annotations already declare readOnlyHint and idempotentHint. Description adds return content (name, date range, sharing, metadata) and failure scenario. No contradictions. Could mention idempotency explicitly but not required.

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?

Description is compact with clear sections: purpose, use cases, alternatives, return info, and failure condition. No unnecessary words.

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 purpose, usage, return content, and failure. Lacks output schema but return fields are described. Sufficient for a simple read tool with one parameter.

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 describes roadmap_id as 'Roadmap ID from list_roadmaps' with 100% coverage. Description reinforces this by noting failure when ID not found and suggesting valid IDs from list_roadmaps, adding practical guidance beyond the schema.

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 settings and metadata. Provides return fields (name, date range, sharing, metadata). Differentiates from similar tools like get_roadmap_complete (though not a listed sibling) and implies distinction from get_roadmap_bars by focusing on settings rather than bars.

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?

Explicitly lists use cases ('Tell me about roadmap X', 'Roadmap settings') and alternatives ('For all data, use get_roadmap_complete'). Clearly explains failure condition and prerequisite (get IDs from list_roadmaps).

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