delete_comment

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

Annotations already declare destructiveHint=true and readOnlyHint=false. The description adds 'cannot be undone', which reinforces the destructive nature but adds no other behavioral context such as authorization requirements or side effects. Since annotations cover the key behavioral traits, the description provides marginal additional value.

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?

Two sentences with no fluff. The first sentence states the purpose, the second adds the critical irreversibility warning. Information is front-loaded and efficient.

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 delete operation, the description covers purpose and irreversibility. No output schema is needed. Parameters are documented in schema (though poorly). The description is largely complete, but could include more context like 'Use with caution' or 'Only delete comments you created'.

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 input schema has 3 required parameters, all with minimal descriptions ('a string that will be trimmed'). The tool description does not add any meaning beyond the schema, such as explaining what each parameter represents or how to obtain them. Schema coverage is 100% but descriptions are poor, and the description fails to compensate.

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 'Delete' and the resource 'a comment from a Huly issue'. It distinguishes from sibling tools like 'update_comment' and other delete operations.

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 warns that the action cannot be undone, implying careful use, but provides no explicit guidance on when to use this tool versus alternatives like delete_issue or update_comment. No comparison with other tools is given.

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