can_merge_pull_request

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

No annotations provided. Description does not state that the tool is read-only, mention permissions, or describe side effects. Lists return fields but lacks behavioral context beyond that.

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 a one-line summary and return info, but the args section is repetitive. Could be more structured, but overall efficient.

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?

Output schema exists but not shown; description mentions key return fields. Lacks error cases, auth requirements, or rate limits. Adequate for a simple checking tool but with gaps.

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%. Description provides minimal parameter info (e.g., 'The project key') which adds little beyond schema titles and types. For 0% coverage, more detailed semantics are needed.

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?

Description uses specific verb 'check' and resource 'pull request merge readiness', lists key outputs (canMerge, conflicted, vetoes). Clearly distinguishes from sibling tools like merge_pull_request (which performs merge) and get_pull_request (which gets full details).

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 vs alternatives. Implies a pre-merge check but doesn't explicitly contrast with merge_pull_request or other PR tools. No when-not or alternative recommendations.

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