github_pulls_update_review

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

With no annotations, the description must convey behavioral traits. It only states the action without explaining effects (e.g., whether the review body is replaced, if the review state changes, or if the review must be in a pending state). Critical details like idempotency or side effects are missing.

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 sentence with no wasted words, but it is overly terse. While concise, it sacrifices needed detail, making it less useful for an agent.

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 lack of output schema and annotations, the description should provide a more complete picture of the tool's behavior, return value, and usage context. It fails to do so, offering insufficient information for confident 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?

Although schema coverage is 100%, the schema descriptions are merely property names (e.g., 'owner', 'repo'), lacking any semantic depth. The description does not clarify the purpose of the 'body' object parameter or the required identifiers, adding no meaning beyond the schema.

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 'Update a review for a pull request' clearly indicates the verb (update) and resource (review for a pull request). Among sibling tools like submit, dismiss, or update review comment, 'update' is distinct, but the description does not specify what aspects of the review can be updated (e.g., body, state), leaving some ambiguity.

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?

No guidance is provided on when to use this tool versus alternatives like 'github_pulls_submit_review', 'github_pulls_dismiss_review', or 'github_pulls_update_review_comment'. The agent receives no context about prerequisites or scenarios.

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