Compare repositories

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

Annotations already cover safety (readOnlyHint=true) and open-world access, so the bar is lower. The description adds genuinely useful cost disclosure — 'about 5 extra API requests per repo' — which tells the agent the price of the health-score path. It stops short of describing the response shape or ordering.

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, front-loaded with the core capability and followed by the one optional flag with its cost. No 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 comparison tool with no output schema, the description covers inputs, compared fields, limits (2-5), and extra cost. Minor gap: nothing about how results are returned (single table, per-repo grouping) or handling of invalid repos.

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% and both parameters are documented in-schema, including the 'owner/repo or github.com URLs' format and the ~5-request cost. The description restates the include_health cost rather than adding new semantics, so the 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+resource ('Compare ... repositories side by side') and enumerates exactly what is compared (stars, forks, language, license, activity, topics). The '2-5 repositories' framing implicitly distinguishes it from single-repo siblings like get_repository, but no sibling is named explicitly.

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?

Gives a clear conditional for the optional parameter ('Set include_health to add health scores'), with cost attached. However, there is no explicit guidance on when to choose this over get_repository, get_repo_health, or find_similar_repositories — the multi-repo scope is only implied.

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