delete_article_comment

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

The description mentions 'Returns text for restoration', providing some behavioral insight about undo capability. However, with no annotations, it lacks details on permanence, permissions, or side effects.

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 extremely concise and well-structured, starting with the purpose and followed by a clear parameter list. No redundant or extraneous information.

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 simple tool with 3 parameters and no nested objects, the description covers the basics. However, it could mention that the comment is removed from the article and that the restoration text can be used to reverse the deletion. An output schema exists but is not referenced.

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?

Despite 0% schema description coverage, the description adds explanations for each parameter: 'article_id: Article ID or database ID', 'comment_id: Comment ID', and 'instance: YouTrack instance (optional)', clarifying their meanings beyond the schema.

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 an article comment', specifying the verb and resource. It distinguishes from sibling tools like 'delete_comment' (issue comments) and 'update_article_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?

No guidance is given on when to use this tool versus alternatives (e.g., 'delete_comment' for issue comments). No exclusions or prerequisites are mentioned.

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