Get Pull Request Review Summary

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

Annotations indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds significant behavioral details: 'Fetches PR details first, then aggregates diffstat, unresolved comments, and CI statuses in parallel.' It also describes the return structure and the review_readiness enum, which goes beyond annotations.

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, with clear sections (Args, Returns). Every sentence adds value, and it is well-structured for quick parsing.

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 the tool's complexity (3 parameters, output schema present, annotations), the description is complete. It covers return values with a structured summary and review_readiness enum, explains parallel fetching behavior, and provides parameter defaults. No 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%, but the text description explains each parameter: repo_slug, pull_request_id, and workspace (optional, defaults to configured workspace). This adds meaning beyond the schema, especially clarifying the optionality and default of workspace.

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 'Get a comprehensive review summary for a pull request' and lists specific components (PR details, diffstat, unresolved comments, CI statuses). It distinguishes from sibling tools like get_pull_request (just PR details) and get_pull_request_diffstat (only diffstat) by aggregating multiple data sources.

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 description mentions 'for efficient AI-assisted code review' but does not explicitly say when to use this tool versus alternatives like get_pull_request or get_pull_request_diffstat. It provides implied usage context but lacks exclusions or alternative recommendations.

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