delete_comment

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

Annotations already indicate destructiveHint=true, so the description adds value by explaining the soft-delete mechanism (retained server-side with deleted_at) and the absence of an edit endpoint. It also details failure modes, which goes beyond the annotation flags.

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?

Description is moderately concise, with each sentence providing essential information (soft-delete, no edit, failure modes). It could be slightly tighter by removing the analogy to subtasks, but overall it is well-structured and front-loaded with the core action.

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?

Given the presence of an output schema (covering return values), the description is complete: it explains the soft-delete behavior, the lack of an edit endpoint, and common failure modes. No critical information is missing for an agent to use this tool correctly.

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?

Input schema has no descriptions (0% coverage), so description must compensate. It adds meaning by explaining the relationship between task_id and comment_id through the failure mode explanation (comment must belong to that task). It also mentions return value (deleted Comment with deleted_at). However, it does not explicitly describe each parameter's purpose or format.

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?

Clearly states 'Delete a comment (soft-delete)' with a specific verb and resource. Distinguishes from sibling tools like delete_subtask and archive_task by mentioning the soft-delete behavior and that no edit endpoint exists, so this is the only way to fix a comment.

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?

Provides explicit guidance: 'if you need to fix a comment, delete it and post a replacement', indicating when to use this tool instead of editing (which doesn't exist). Also advises to re-fetch comments before retrying on 404. No explicit when-not-to-use, but context is clear.

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