Generate a categorized changelog

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

Discloses the internal algorithm (Conventional Commits parsing with fallback to keyword heuristics), which is beyond the basic purpose. However, it does not explicitly state that the operation is read-only, mention error handling, or note rate limits. The lack of annotations increases the burden, but the description covers essential behavioral traits well.

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 sentences, no filler. First sentence front-loads the core purpose, second adds algorithm details, third gives usage guidance. Every sentence is essential and well-organized.

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 the tool's complexity (5 parameters, no output schema, no annotations), the description sufficiently covers purpose, algorithm, usage sequence, and output format. It provides enough context for an agent to invoke the tool correctly without additional information.

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?

With 100% schema coverage, the schema already describes each parameter. The description adds value by explaining that from_ref and to_ref are 'refs', recommends using list_tags to find valid ref names, and ties parameters to the repository context (public GitHub repo). This extra context raises it above the baseline of 3.

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 the verb 'Generate', the resource 'categorized Markdown changelog', and the context 'between two refs in a public GitHub repository'. Differentiates from sibling 'list_tags' by positioning itself as the main tool and recommending list_tags for discovering valid ref names.

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 states when to use this tool ('main tool') and when to use a sibling ('use list_tags first if you don't know valid ref names'). Provides clear prerequisite guidance, which helps the agent decide the correct sequence.

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