github_get_pr_files

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions 'pagination support', which is useful, but fails to describe critical behaviors such as rate limits, authentication requirements, error handling, or the format of returned data (e.g., file paths, change types). For a read operation with multiple parameters, this leaves significant gaps.

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, well-structured sentence that efficiently conveys the core functionality and key feature (pagination). It's front-loaded with the main purpose and avoids unnecessary details, making it highly concise and easy to parse.

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 complexity (6 parameters, no annotations, no output schema), the description is incomplete. It lacks details on authentication, rate limits, error cases, and the structure of returned data (e.g., list of files with changes). For a tool that interacts with GitHub's API and handles pagination, this omission makes it inadequate for safe and effective use by an AI agent.

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%, meaning none of the 6 parameters have descriptions in the schema. The description only implies pagination-related parameters ('page', 'per_page') and hints at 'include_patch' but doesn't explain what these mean or how they affect results. It doesn't cover required parameters like 'repo_owner', 'repo_name', and 'pr_number', leaving their purpose unclear.

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 the verb ('Get') and resource ('files changed in a pull request'), making the purpose specific and understandable. However, it doesn't explicitly distinguish this tool from sibling tools like 'github_get_pr_details' or 'github_get_pr_status', which reduces clarity about its unique role in the GitHub PR toolset.

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 provides no guidance on when to use this tool versus alternatives. It doesn't mention scenarios where this tool is preferred over other GitHub PR tools (e.g., 'github_get_pr_details' for metadata or 'github_get_pr_checks' for status checks), nor does it specify prerequisites like needing a valid PR number or repository access.

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