submit_pull_request_review

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 states the return format ('Normalized write-result mapping, or a structured error mapping') but does not mention that this is a write operation affecting the PR, nor any required permissions, side effects, or idempotency. It adds value over an empty description but leaves key behavioral aspects undisclosed.

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 well-structured with an Args section, a Returns section, and a concrete example. The purpose is front-loaded in the first sentence, and the formatting (code blocks, bullet points) makes it easy to scan. Every sentence contributes value, with no fluff.

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 description covers all six parameters, describes the return shape, and provides an input/output example. Since an output schema exists, detailed return fields are not needed in the description. It does not mention potential side effects or prerequisites, but given the tool's moderate complexity and the presence of an output schema, it is reasonably complete.

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 coverage is 0%, meaning the schema provides no parameter descriptions. The description compensates by listing every parameter with a brief explanation, notably clarifying the 'event' values ('approve', 'request_changes', 'comment'), that 'body' is optional, and what 'raw' does. This adds meaning beyond the schema's bare titles, though it lacks types and constraints.

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 starts with 'Submit an approve, request-changes, or comment review,' a specific verb (submit) and resource (pull request review) that clearly distinguishes this from sibling tools like add_pull_request_comment or merge_pull_request. The purpose is immediately unambiguous.

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 explains what the tool does but provides no explicit guidance on when to choose it over alternatives. Sibling tools such as add_pull_request_comment or list_pull_request_reviews serve distinct purposes, but the description does not mention them or give conditions for use. The context is implied by the action, but explicit direction is missing.

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