delete_issue_comment_by_comment_id

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

The description adds no behavioral context beyond what the annotations already provide. It does not mention that deletion is permanent, whether it can be undone, or any permission requirements, despite being a destructive operation. The idempotentHint and destructiveHint annotations cover the safety profile, but the description itself contributes no further transparency.

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 front-loaded: the purpose appears in the first sentence, followed by the endpoint and parameter list. Every line adds relevant information without filler or repetition. It is appropriately sized for a one-parameter delete tool.

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 simple one-parameter delete operation, the description together with the annotations and output schema is largely complete. The resource, HTTP method, parameter, and destructive nature are all represented. It lacks only optional context like auth requirements or side effects, but those are not critical given the existing annotations and simplicity of the tool.

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 documents the single parameter as "comment_id: Issue Comment ID," which provides a basic mapping from argument to meaning. However, this adds only marginal value over the schema's existing title "Comment Id" and does not explain expected format, source, or constraints. With schema_description_coverage at 0%, the description partially compensates but does not go beyond a restatement.

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 opens with a direct, specific statement: "Delete issue comment." This clearly identifies the verb and resource, and the endpoint DELETE /api/v1/issueComment/{commentId} reinforces the action. It is easily distinguished from sibling tools like update_issue_comment_by_comment_id or delete_issue_by_issue_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?

No guidance is provided about when to use this tool versus alternatives. The description does not mention related operations such as updating an issue comment, nor any conditions, prerequisites, or exclusions. Usage must be inferred entirely from the tool name and the one-line action.

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