delete_comment

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

Annotations are absent, so the description carries the full burden. It discloses that range markers are removed, which is an additional behavioral detail beyond just deletion. However, it does not mention permanence, irreversibility, required permissions, or potential side effects on other comments.

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 two sentences plus a list of arguments. The first sentence states the core purpose, and the Args provide necessary parameter info. Every sentence is necessary and there is no fluff.

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 simple with one parameter and an output schema. The description covers the main action and parameter semantics. It lacks mention of irreversibility or error conditions, but given the low complexity and presence of output schema, it is reasonably complete.

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%, but the description includes an Args section with 'comment_id: ID of the comment to delete,' which adds meaning beyond the schema's title and type. This explains the parameter's purpose, though it could reference where to obtain the ID.

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 'Delete a comment' with the verb 'delete' and resource 'comment'. It also adds 'and remove its range markers,' providing extra specificity that distinguishes from related tools like resolve_comment or update_comment, which do not delete.

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 implies usage for deletion but does not provide explicit guidance on when to use this tool versus alternatives like resolve_comment or reply_to_comment. No when-not-to-use or alternatives are mentioned, leaving the agent to infer based on the name.

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