edit_issue_comment

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

There are no annotations, so the description carries the full behavioral burden. It only indicates that the operation is an edit, but does not disclose whether the body is fully replaced, what permissions are required, or what happens if the comment or issue does not exist.

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 concise sentence with no filler. It front-loads the action and resource, and every word contributes meaning.

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 five required parameters, no annotations, and no parameter descriptions, this is not complete enough to guarantee correct invocation. The output schema helps with return values, but the description still lacks explicit parameter mapping and behavioral context.

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?

With 0% schema description coverage, the description needs to compensate, but it only hints that 'index' relates to the issue or pull request. It does not explicitly explain owner, repo, index, comment_id, or how body is used, leaving the ambiguous 'index' parameter under-described.

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 action ('edit') on a specific resource ('a comment') and scopes it to 'an issue or pull request.' This clearly distinguishes the tool from sibling operations like create_issue_comment, delete_issue_comment, and list_issue_comments.

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 about when to choose this tool over alternatives such as create_issue_comment or delete_issue_comment. It also does not mention prerequisites like comment ownership, permissions, or whether the comment must already exist.

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