aiworkhub_dashboard_roadmap_detail

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

Adds meaningful context beyond the readOnlyHint: confirms roadmap_id format validation and that only Roadmap and task stores are read with no state mutation. Does not mention pagination or error behavior for an invalid id, but annotations already carry the safety profile so the added value is solid.

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?

Three tight sentences with the READ-ONLY marker and capability front-loaded. Slight redundancy between the 'READ-ONLY' prefix and the closing 'reads ... without mutating state', but nothing wasteful enough to penalize heavily.

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?

Output schema exists so return values need no explanation, yet the description still enumerates the payload shape. Safety profile, sibling routing, and validation behavior are all covered for a simple 2-parameter read tool.

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 description coverage is 100%, so both roadmap_id format and event_limit clamping (1..100, default 50) are already documented. The description only echoes the id validation, adding little beyond the schema — baseline 3 applies.

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?

States a specific verb ('return one Roadmap outcome') plus the exact payload contents (linked task progress, wave projection, audit events), and explicitly contrasts with aiworkhub_dashboard_roadmap_list for browsing. An agent can pick this tool over its sibling without opening a schema.

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 this to inspect a specific Roadmap item's dependencies, linked tasks, and event log' followed by the selecting condition for the alternative ('use list to browse all'). Both when-to-use and the alternative are named.

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