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

Annotations already declare readOnlyHint=true, so the safety profile is covered without help from the description. The description adds the mutually exclusive input contract and the underlying REST path, but says nothing about the shape or nature of the diff returned, so it exceeds the annotation baseline only modestly.

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?

Two tight sentences: purpose first, then the input constraint, then the endpoint reference. Nothing is redundant and the most decision-relevant information is front-loaded.

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?

There is no output schema, so the description ideally would hint at what a comparison yields (coverage delta, impacted files), which it does not. All inputs, required fields, and the read-only nature are otherwise adequately covered for a six-parameter tool.

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%, so the baseline is 3. The description adds real meaning beyond the schema by framing base/head and pullid as an either/or choice; the schema describes each field individually but never states the cross-parameter exclusivity.

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 ('Compare coverage') plus the two comparison modes (commit range vs. pull request) and even the backing REST endpoint. This clearly separates it from siblings such as codecov_get_commit, codecov_get_pull, and codecov_get_coverage_totals, which report rather than diff.

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 the usage rule: 'Provide EITHER both base and head, OR pullid,' which is the key selection decision for this tool. It does not, however, mention when to prefer this over sibling tools like codecov_compare_impacted_files or codecov_get_pull, so it stops short of full alternative routing.

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