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

The annotations already mark this as readOnly and non-destructive, and the description reinforces that while adding useful nuance: the risk score is qualified as to whether it describes the current head, CI state is 'as the merge gate sees it,' and AI-review verdicts are a 'trio.' This goes beyond the annotation bar, though it does not discuss staleness, caching, or failure behavior.

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?

A single front-loaded sentence that immediately states the core purpose and then enumerates the computed outputs. There is no filler, repeated metadata, or unnecessary explanation.

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?

This tool aggregates a fairly complex status view and has no output schema, but the description lists every major result category, including a subtle head-match qualifier for the risk score. It does not give exact return shapes, but it provides enough context for an agent to select and invoke the tool 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?

The schema has zero description coverage for all three parameters; owner, repo, and number are bare name/type declarations. The description does not add field-level semantics—it only indicates that the tool operates on a PR. Even though these are conventional GitHub identifiers, the description fails to compensate for the schema gap.

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 opens with a concrete verb and resource: 'Compute a one-shot status summary for a PR,' then enumerates the specific components included. This makes it easy to distinguish from siblings like get_pr or get_workflow_run because it is clearly an aggregation of state, risk, CI, review, and gate signals rather than a single-resource fetch.

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 'one-shot' phrasing implies that this tool consolidates data that might otherwise require multiple calls, but it never explicitly states when to prefer this tool over alternatives such as get_pr, get_workflow_run, or list_prs. Usage context is implied rather than clearly stated with exclusions or alternatives.

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