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

With no annotations, the description carries the burden and does disclose the return payload: all intermediate releases, deprecation/removal markup, breaking tags, and nearcore flags, which tells the agent the result is aggregated rather than a single diff. It omits edge-case behavior such as what happens for unknown products, unavailable versions, or non-existent ranges, so the disclosure is rich but not complete.

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?

Front-loaded with the outcome, then scope, then the usage example, with no filler sentences. The enumerated product list duplicates the schema's own enumeration, which is mildly redundant but short enough not to crowd out the substantive content.

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 three-required-parameter read tool with no annotations and no output schema, the description covers purpose, supported inputs, what is returned, and the motivating scenario. What is missing is failure/empty-result behavior and the provenance of the breaking-change data, which matters for a tool whose value rests on completeness of intermediate releases.

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 100%, so product, from_version and to_version are already documented in the schema, including the GitHub-repo alias form and prerelease semantics. The description mostly repeats the product list and only adds value through the worked example that shows valid version values; baseline 3 applies.

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?

States a specific verb and resource (breaking changes between two versions of one NEAR product) and enumerates exactly what comes back: every intermediate release, removals/deprecations from notes, breaking-marked lines, and nearcore's CODE_COLOR, PROTOCOL_UPGRADE and SECURITY_UPGRADE flags. This is clearly distinct from a general changelog tool like get_recent_changes because of the explicit between-versions, breaking-only framing.

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?

Provides a concrete when-to-use trigger ("Use when upgrading") plus a real example question mapping a migration from 5.1.0 to 7.4.0. It does not name a sibling alternative or state when not to use it (e.g. for a single release's full notes), so it stops short of full routing guidance.

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