github_get_pr_checks

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

No annotations are provided, so the description must disclose behavioral traits. It only says 'Get', implying read-only, but does not mention any prerequisites, permissions, rate limits, or what happens when a PR has no checks. The result format is also not described beyond 'check runs and status'.

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, concise sentence that starts with the verb 'Get' and immediately states the resource and scope. No filler or repetition of schema details.

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?

The tool is simple with 3 parameters and no output schema. The description communicates the core function well enough for an agent to understand what is returned (CI/CD check runs and status). It lacks some detail about edge cases, but for a basic read operation this is adequate.

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 input schema covers all three parameters with descriptions (owner, repo, pull_number). The description adds no extra parameter-specific meaning, only restating the target pull request context. Schema coverage is 100%, so 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 clearly states a specific verb ('Get') and resource ('CI/CD check runs and status') targeted at a specific pull request. This distinguishes it from sibling tools like github_get_pr_comments and github_get_pr_details, which focus on different aspects of a PR.

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 clear context for when to use this tool: when you need CI/CD check runs and status for a specific pull request. It does not explicitly mention alternatives or exclusions, but the purpose is specific enough to guide selection among siblings.

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