get_pull_request

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

No annotations are provided, so the description carries the full burden. It goes beyond a bare fetch statement by disclosing the concrete data categories returned: changed files, commits, reviews, CI check status, and linked issues. This gives the agent a meaningful expectation of the tool's behavior, though it does not mention rate limits, authorization, or error 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?

The description is a single, front-loaded sentence that states the action and the key returned data without unnecessary words. It is concise and structured effectively, earning its place entirely.

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 has an output schema, so return-value details do not need to be in the description. However, the description lacks explicit usage guidance and parameter clarification, and there are no annotations to cover safety or behavioral context. The core purpose is clear, but the overall definition is only minimally complete for a 3-parameter read tool.

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%, and the description does not explain owner, repo, or pr_number. While these parameter names are somewhat self-explanatory in a GitHub context, the description provides no additional semantics or format guidance to compensate for the missing schema documentation.

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 names a specific verb and resource: 'Fetch a pull request', and further specifies the content returned (changed files, commits, reviews, CI check status, linked issues). This clearly distinguishes it from sibling tools like get_issue, which target issues rather than pull requests.

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?

Usage is implied by the resource: use this when you need pull request data, and get_issue for issue data. However, there is no explicit guidance on when to choose this over alternatives or any exclusions, such as when to use search_issues instead.

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