compare_repos

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

With no annotations, the description carries the full burden. It discloses one useful constraint ('public'), but says nothing about authentication, network/clone cost, rate limits, or what the comparison returns (a delta, a winner, per-ref breakdown). For a mutating nothing but potentially expensive fetch tool, this is thin.

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?

A single front-loaded sentence with no filler; the scope qualifier 'between two' and 'SLOC totals' are efficiently packed in. It is appropriately sized, though it stops short of any elaboration.

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 would ideally hint at the return shape (e.g., comparison of SLOC deltas), and with no annotations it should note access constraints. It covers the what and the scope but leaves the agent guessing on results and side effects.

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% and each of the four parameters (left/right repo URL plus optional left/right ref) is described in the schema, so the baseline 3 applies. The description adds no syntax, default-ref, or format detail beyond what the schema already provides.

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 (Compare), resource (GitHub repositories/refs), and the exact metric (SLOC totals), which cleanly separates it from the broad-sounding sibling analyze_repo. It is clear without naming the sibling or describing output form.

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?

Usage is implied: call it when you want to contrast two repos or refs. There is no explicit when-to-use vs analyze_repo, no stated prerequisites, and no note on what happens with private repos beyond the word 'public'.

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