updatePullRequestComment

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

No annotations are provided, so the description carries the full behavioral burden. It only indicates mutation via 'Update' but does not disclose whether the update is partial or full, whether permission/ownership is required, whether the change is reversible, or what effect it has on existing 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 a single succinct sentence with no filler words. It is appropriately compact, though slightly under-specified for the tool's complexity; still, it avoids redundancy and front-loads the core action.

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 mutation tool with no annotations, no output schema, and five parameters (two undocumented), the description is too thin. It omits usage context, behavioral consequences, and return behavior, leaving an agent to infer critical details from names and schema alone.

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 description adds no parameter meaning beyond what the input schema already provides. Schema coverage is 60%: content, comment_id, and pull_request_id have descriptions, but repo_slug and workspace remain undocumented, and the description does nothing to clarify them.

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 states a specific verb ('Update'), resource ('an existing comment'), and context ('on a pull request'). The word 'existing' distinguishes it from add/delete comment siblings, though it does not mention the updated fields or distinguish it from updatePullRequest beyond the resource name.

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?

There is no guidance about when to use this tool versus alternatives. With siblings like addPullRequestComment, deletePullRequestComment, and updatePullRequest all present, the description offers no explicit when/when-not or alternative routing.

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