Compare branches

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the output categories (ahead/behind counts, common commit, changed items) but does not disclose whether the operation is read-only, whether it requires specific permissions, how pagination works, or what the response format looks like. The description adds some value but leaves significant behavioral gaps.

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 sentence that is concise and front-loads the main action and output. It earns its place with no filler, though it could be slightly more structured by separating the output list. Overall, it is appropriately sized.

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 tool with 5 parameters, 0% schema coverage, no annotations, and no output schema, the description is too thin. It does not explain parameter semantics, return value structure, or edge cases (e.g., branches with no common ancestor). An agent would need to guess or call the tool to learn its behavior.

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 0%, so the description must compensate for undocumented parameters. It does not explain the meaning of 'baseBranch' vs 'targetBranch' (which is the reference and which is the comparison), nor does it explain 'top', 'project', or 'repositoryId'. The description only mentions 'two branches' generically, leaving the agent to guess parameter roles.

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 verb ('Compare') and resource ('two branches') and lists the return values (ahead/behind counts, common commit, changed items). It is clear what the tool does, though it does not explicitly distinguish itself from sibling tools like get_pull_request_diff or list_commits, which also deal with branch/commit comparisons.

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 provided on when to use this tool versus alternatives. The description does not mention that this is for branch-to-branch comparison, nor does it exclude cases where a pull request diff or commit list would be more appropriate. An agent must infer usage from the name and description alone.

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