Release Notes Generator

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

Annotations only indicate readOnlyHint=true. The description adds behavioral context: it generates release notes by grouping, extracting breaking changes, and linking PR/issue references. This goes beyond the annotation to explain what processing occurs, though it could detail more about output format.

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?

The description is concise with two sentences plus a note. The main action is front-loaded, the capabilities are listed succinctly, and the critical usage condition is highlighted as a note. No wasted 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?

Given the tool has 4 parameters (1 required) and no output schema, the description covers the core functionality and a key usage condition. It lacks explicit mention of return format, but the purpose is clear enough. Sibling tools are all different analyses, so no confusion.

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 coverage is 100% with descriptions for each parameter. The description adds value by explaining the grouping behavior (conventional commit type) and the condition for repo_path. It also clarifies that grouping can be by type, scope, or author, which aligns with the enum but provides functional context.

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?

The description clearly states the tool generates structured release notes from commits between two git refs, groups by conventional commit type, extracts breaking changes, and links references. This specific verb-resource pair distinguishes it from sibling tools that analyze code hotspots, churn, etc.

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?

The description explicitly provides a usage note about when repo_path is required ('If the server was not started inside a git repo, you MUST provide repo_path'). It does not give when-not-to-use or alternatives, but the context is clear enough for an agent to decide when to invoke this tool.

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