updatePullRequestComment

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

Description only says 'Update a comment' with no details on behavior (e.g., does it replace entire content or patch? Are there any side effects? Requires specific permissions?). No annotations provided to compensate.

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?

Ultra-concise single sentence with no wasted words. Every word adds value. Front-loaded with verb and resource.

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?

Despite schema covering parameters, the description lacks guidance on return values, error handling, or expected behavior. As a mutation tool with no annotations or output schema, it should provide more context for agent decision-making.

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?

Input schema has 100% description coverage for all 5 parameters, so schema already explains each parameter. Description adds no additional semantics beyond restating the action. Baseline score of 3 applies.

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?

Description clearly states the action ('Update') and resource ('a comment on a pull request'). Verb+resource combination distinguishes it from sibling 'addPullRequestComment' (create) and 'reopenComment' (reopen). However, it does not explicitly differentiate from other comment-related tools.

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 on when to use this tool versus alternatives like addPullRequestComment or reopenComment. No prerequisites, not mentioned when to avoid using it.

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