update_issue_comment_by_comment_id

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

Annotations already convey that this is not read-only, is idempotent, and is not destructive. The description adds a useful discovery pointer to the GET/schema endpoint but does not elaborate on update semantics, side effects, or authorization requirements.

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 compact and well-structured: a one-line purpose, the HTTP method/path, and a short Args list. Every sentence adds useful information with no redundancy.

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?

The tool is a simple two-parameter update with an output schema and helpful annotations. The description covers the purpose, endpoint, parameter roles, and a discovery strategy for body fields, which is adequate for an open-schema body.

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 compensates by labeling comment_id as a path parameter and body as the request payload. It also tells the agent to consult the matching GET or /schema endpoint to learn expected body fields, which is valuable for an open additionalProperties object.

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 the operation clearly: 'Update issue comment' and reinforces it with the PUT endpoint. This distinguishes it from sibling tools like create_issue_by_issue_id_comment, get_issue_comment_by_comment_id, and delete_issue_comment_by_comment_id.

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 makes clear it updates an existing issue comment and advises reading the matching GET or /schema endpoint first. However, it does not explicitly state when to prefer this tool over alternatives or mention any exclusions.

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