Github Compare Repos

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

No annotations are provided, so the description carries the full burden. It only says the tool compares current snapshot data; it does not disclose whether the operation is read-only, whether authentication is needed, whether rate limits apply, or what behavioral side effects or constraints exist. This is minimal for a tool with no annotation support.

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 a single, direct sentence with no filler or redundant repetition of the title. It front-loads the core purpose and earns its place, though it is terse in other dimensions.

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?

With only one parameter and an output schema present, the structural complexity is low and return-value details are covered elsewhere. However, the lack of usage guidance and behavioral context means the description is only minimally adequate for an agent deciding when and how to invoke the 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?

The schema already documents the only parameter `repos` with an example, and schema description coverage is 100%. The description adds the context of comparing snapshots, but does not add meaning beyond the schema for the parameter itself, so the baseline of 3 is appropriate.

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 states a specific action ('对比' / compare) and a specific resource ('多个 GitHub 仓库的当前快照数据' / current snapshot data of multiple GitHub repos). This distinguishes it from sibling github_search_repos, which is about searching repos rather than comparing existing repo snapshots.

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?

No guidance is given about when to use this tool versus alternatives such as github_search_repos. The agent must infer usage from the tool name and sibling list; there is no explicit when-to-use or when-not-to-use guidance.

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