compare_branches

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

No annotations are provided, so the description carries full burden. It does not explicitly state that the operation is read-only, which permissions are required, or any limits. The description only covers the basic operation without behavioral traits beyond the defined action.

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 concise: two sentences plus parameter list. The purpose is front-loaded, and each parameter line is clear. No redundant information. Slightly more detail could be added without harming conciseness.

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?

Given no annotations, output schema, and 4 parameters, the description is incomplete. It does not describe the diff summary format, pagination, or error cases. An agent lacks context on what the response contains or how to interpret results, making the tool hard to use 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 0%, so the description adds all parameter context. It explains that project uses a default if not specified, repository_id can be ID or name, and clarifies the roles of base and target branches. However, it lacks format constraints (e.g., branch naming) or examples.

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 clearly states the tool's action: 'Compare two branches and show the diff summary'. The verb 'compare' and resource 'branches' are specific, and the output type is mentioned. This distinguishes it from siblings like list_branches and get_commits.

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 explicit guidance on when to use this tool versus alternatives. The description does not mention prerequisites, when-not-to-use, or provide context like 'use list_branches to see available branches first'. Sibling tools are listed but not referenced.

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