gitea_get_pr_diff

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

No annotations are provided, requiring the description to carry full behavioral disclosure. The '[UNIFIED]' tag indicates the output format (unified diff), but the description fails to state whether the operation is read-only/safe, what authentication is required, or whether the return value is a string, object, or streamed content.

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 at effectively one sentence. While efficient and front-loaded, it may be insufficiently informative given the complete lack of schema descriptions and annotations. Every word earns its place, but critical explanatory content is absent.

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 four undocumented parameters, no output schema, and no annotations, the description is incomplete. It does not describe the return value structure, error handling for non-existent PRs, or required permissions necessary for successful invocation.

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%, requiring the description to compensate for undocumented parameters. The description mentions none of the four parameters (site, owner, repo, pr_number) nor explains their semantics, such as whether 'site' refers to a base URL, instance name, or API endpoint.

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' and identifies the resource as 'unified diff of a pull request', clearly stating the tool's function. The '[UNIFIED]' prefix specifies the output format. However, it does not explicitly differentiate from sibling tool 'gitea_get_pull_request' which likely retrieves PR metadata rather than diff content.

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 such as 'gitea_get_pull_request' or 'gitea_list_pr_files'. It omits prerequisites (e.g., PR must exist) and does not indicate error conditions or rate limiting considerations.

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