adr_overview

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

With no annotations, description provides minimal behavioral context. States 'generate' but does not explain side effects, output format, or that it likely returns a diagram (implied by format parameter). No mention of data persistence or modifications.

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?

Single sentence with no fluff. Could be slightly expanded for clarity without becoming verbose.

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?

Given 14 sibling tools and 3 parameters, the description is too sparse. Does not explain output schema (though exists), usage context, or how it differs from similar diagram tools. Inadequate for accurate selection.

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 0%, so description must explain parameters. It only references the status_filter via 'filtered by status', but does not explain 'format' (default mermaid) or 'project_path' (likely needed for project context). Partial compensation.

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 generates an overview diagram of ADRs with optional status filter. However, sibling 'adr_diagram' also produces diagrams, and the description does not differentiate them.

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?

No guidance on when to use this tool versus alternatives like adr_diagram or adr_list. Does not specify exclusions or prerequisites.

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