delete_workitem_comment

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

Annotations already declare destructiveHint=true, readOnlyHint=false and idempotentHint=false, so the safety profile is known without the prose. The description's one addition is the mandatory confirm=true gate, which is genuinely useful behavior, but it says nothing about permissions required, whether deletion is permanent, or what happens when confirm is false or the comment does not exist.

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 short sentences with zero filler: the action comes first and the hard prerequisite second. Nothing is redundant or padded.

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 output schema and destructive annotations relieve the description of explaining return values and risk, and the current-project scope is stated. Still, for a destructive mutation with three fully required, undescribed parameters, the definition should clarify what confirm=false produces and any permission requirements.

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%, so the description must carry parameter meaning, yet it only glosses confirm (a boolean whose failure semantics remain unstated). workitem_id and comment_id have no meaning beyond their titles and type constraints, and the phrase 'current project' hints at an implicit context the schema never exposes.

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?

Names a specific verb and resource in one clause – deleting a single comment belonging to a workitem, explicitly scoped to the current project – which cleanly separates it from create_workitem_comment, update_workitem_comment and list_workitem_comments. It stops short of naming those siblings, so differentiation is implicit rather than stated.

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 confirm=true prerequisite is a concrete call requirement, but the description offers no guidance on when to prefer this over update_workitem_comment or on any preconditions beyond confirmation. Usage is inferred from the tool name and resource.

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