pr_diffstat

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

There are no annotations, and the description does not disclose behavioral traits beyond the basic read-only implication of 'Get'. It does not mention permissions, rate limits, or output format, leaving the burden unmet.

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 extremely concise with a single purpose line and a structured Args list. Every sentence adds necessary information; no filler or redundancy.

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?

For a simple read tool, the description covers what it does and the parameters. The existence of an output schema means return values are handled elsewhere. However, the lack of any behavioral or prerequisite context, combined with no annotations, leaves some gaps, though not significant for this tool's simplicity.

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 Args section provides human-readable one-line meanings for each parameter (e.g., 'PR ID number', 'Workspace slug'), which adds value over the schema that only lists types and defaults. However, it does not explain where to find these IDs/slugs or clarify that workspace/repo are optional despite defaults.

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 uses the specific verb 'Get' with the resource 'diffstat (files changed summary)' for a pull request, clearly distinguishing it from sibling tools like pr_diff and pr_commits. The parenthetical explanation makes the term 'diffstat' accessible.

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 implies usage when a summary of file changes is needed, but it does not explicitly state when to use this tool over alternatives like pr_diff or pr_commits. No exclusion criteria or alternative tool references are provided.

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