get_pull_request_checks_tool

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It discloses the classification logic (passed, failing, pending, skipped), explicitly states that SKIPPED is not a failure, and explains the semantics of ready_to_merge (true only when nothing is failing/pending and PR is not known-unmergeable). This gives the agent a clear model of the tool's behavior. It does not discuss edge cases (e.g., no checks) or potential side effects, but for a read-only tool this is acceptable.

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 two sentences, front-loading the primary purpose and then adding a concise clarification. It is free of fluff and every sentence contributes meaningful information: the main action and the critical interpretation of the boolean. Excellent structure.

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 presence of an output schema (not shown but indicated), the description does not need to describe the return type in detail. It explains the most important output field (ready_to_merge) and its semantics. For a tool with 3 parameters, all fully described in the schema, and a clear behavioral contract, the description is complete enough. A minor gap is not stating what happens when there are no checks, but that is a minor edge case.

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 100%, so the description adds little beyond what the schema already provides. The description does not elaborate on parameter meaning (e.g., how repo and pull_number are used), but the schema is explicit. There is no requirement for the description to compensate here, so a baseline 3 is appropriate.

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 states a clear action ('Get a CI verdict') and a specific resource ('a PR'), and explicitly distinguishes its purpose from a generic check by highlighting the skipped-vs-failed distinction. It also names the key output (ready_to_merge), so an agent knows exactly what the tool provides. This clearly sets it apart from sibling tools like list_workflow_runs_tool or get_pull_request_diff_tool.

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 gives concrete guidance on how to interpret the result (use ready_to_merge as the merge signal). It implies the proper context of use (evaluating CI status) but does not explicitly contrast with alternatives or state when not to use it. For a read-only tool with a distinct purpose, this is sufficient but not exhaustive.

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