changelog-generate

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

Discloses behavior: groups commits into sections, returns markdown or JSON, no API key needed. However, does not mention maximum commit limit (500 in schema) or handling of non-conventional commits. Since no annotations, description carries full burden but leaves some gaps.

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, front-loaded with purpose, efficient explanation of grouping and output. 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?

No output schema, but description clarifies return types. Covers core functionality; could detail JSON structure more, but sufficient for a straightforward transform.

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 parameter descriptions. Description adds value by explaining grouping logic and output types (markdown/JSON), which goes beyond schema. Slight extra context on default version and date (defaults are in schema but description reinforces).

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?

Description clearly states the verb 'Converts' and resource 'commit messages to a keep-a-changelog release block'. It distinguishes from siblings as no other tool handles changelog generation.

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?

Implies usage for converting conventional commits to changelog format. Notes 'No API key — pure transform' which guides usage as a local transformation. Could be more explicit about when to use vs alternatives, but no direct sibling exists.

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