github_repos_compare_commits

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

Annotations already cover the safety profile (readOnly, idempotent, openWorld), so the description earns credit for disclosing the response payload — status, ahead/behind, commit list, file changes. It omits any mention of pagination limits despite page/perPage existing, a minor gap.

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 sentences, zero filler, front-loaded with the purpose and return content before the basehead syntax note. Every clause carries information an agent needs.

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 no output schema, the description shoulders the return-value burden and does so by naming the comparison fields. What's missing is pagination behavior for a tool that clearly paginates (page/perPage present), but otherwise it is sufficient to call the tool correctly.

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 the schema already documents owner, repo, basehead, page and perPage. The description re-emphasizes the three-dot basehead format and cross-fork owner prefixing, which is helpful but largely duplicates the schema text; 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 ('Compare two refs') and enumerates the output: status, ahead/behind counts, commits, and changed files. This is clearly distinguishable from siblings like github_repos_list_commits (single branch history) or github_pulls_list_files (one PR's files).

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?

The phrase 'get what is in one and not the other' implicitly conveys the use case, and fork-prefix guidance is given. However, it never states when to prefer this over alternatives such as github_repos_list_commits or github_pulls_get_diff, and gives no exclusions or prerequisites.

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