Full changelog between two versions

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

With no annotations provided, the description carries the burden of disclosing behavior. It reveals that the output includes all release notes (not just breaking lines), the inclusive/exclusive range semantics, and the newest-first ordering. It does not mention error handling or potential network behavior, but these are less critical for a read-only fetch. The addition of the prose-style nuance adds useful context beyond a bare description.

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 two sentences, front-loaded with the action ('Return the complete release notes') and followed by direct usage guidance. Every phrase earns its place, with no redundancy or filler.

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?

For a read-only retrieval tool with no output schema, the description provides enough operational context: purpose, boundaries, ordering, and use cases. The truncation behavior is covered by the maxChars parameter schema, so its absence from the description is not a gap. It does not specify what happens if the version range is invalid, but that is a minor omission for a tool of this simplicity.

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?

The input schema provides 100% coverage with clear descriptions for all four parameters. The description's phrase 'between from (exclusive) and to (inclusive)' restates the schema's own descriptions, adding no new semantic information. The maxChars parameter is fully described in the schema, so the description adds no extra value there.

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 returns complete release notes between two versions, with explicit boundaries (from exclusive, to inclusive) and ordering (newest first). It distinguishes itself from the sibling tool breaking_changes_between by noting it returns 'not just breaking lines'.

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 says when to use it: when full context (new features, fixes, deprecations) is needed, or when breaking_changes_between reports prose-style breaking notes. It implicitly communicates when not to use it (when only breaking changes are needed), making the alternative clear.

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