edit_pull_request_comment

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

No annotations are available, so the description carries the full burden of disclosing behavioral traits. It does not mention that this is a mutation, potential permission requirements, reversibility, side effects (e.g., whether the edit overwrites the entire comment), or any rate limits. The one-sentence description adds no behavioral context beyond the obvious.

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 terse, but this is under-specification rather than conciseness. While the sentence 'Edit a pull request comment.' earns its place, it does not provide enough substance to support effective tool usage, making it incomplete rather than efficiently concise.

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 and a 0% parameter description coverage, the description is severely incomplete. It does not mention return values (despite an output schema existing), error conditions, concurrency issues, or any usage context. This is inadequate for an agent to use the tool correctly.

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%, and the description does not compensate. The parameter names (text, comment_id, pull_request_id) are minimally self-explanatory, but the description does not clarify their meaning or relationships. For instance, it does not state that 'text' is the new content of the comment or that pull_request_id identifies the PR containing the comment.

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 clearly states the verb 'edit' and the resource 'pull request comment', which immediately distinguishes it from sibling tools like create or delete. However, it lacks any additional context about what editing entails, so it does not fully differentiate from the 'update_pull_request' tool, though that operates on a different resource.

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 offers no guidance on when to use this tool versus alternatives such as create_pull_request_comment or delete_pull_request_comment. No context about prerequisites, use cases, or when not to use it is provided.

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