merge_pull_request

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

Discloses version for optimistic locking and strategy examples, but does not explain side effects (e.g., PR closure, branch deletion) or required permissions. With no annotations, more detail is needed.

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?

Description is concise with one line and a bullet-like list. No unnecessary content, though could be slightly more structured.

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?

Lacks information on preconditions (e.g., PR must be open, mergable) and error conditions. Has output schema, so return values need no explanation, but overall completeness is adequate but not thorough.

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?

Adds meaning beyond schema (0% coverage) by describing each parameter, including optimistic locking for version and example strategies. However, some descriptions are tautological (e.g., 'project_key: The project key').

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 'Merge a pull request.' which is a specific verb+resource, and it distinguishes from siblings like create, approve, decline, etc.

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 on when to use this tool versus alternatives (e.g., can_merge_pull_request, create_pull_request). No mention of prerequisites like approval status or conflict resolution.

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