ado_work_item_comment_add

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

No annotations are present, so the description must disclose behavior itself. It states the write-mode requirement and makes the mutating nature apparent via 'Add', which is useful. But it doesn't say what happens when write mode is disabled, whether permissions are needed, or whether the action is reversible.

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?

A single sentence that front-loads the action and adds only one relevant condition. No filler or repetition of schema fields.

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 3-parameter tool with an output schema, the core action is clear and required fields are present in the schema. However, the 'write mode' prerequisite is unexplained and no annotation or description covers error behavior or parameter semantics beyond names, leaving some gaps.

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%, and the description mentions none of the parameters. The names work_item_id, text, and project are somewhat self-explanatory, but the description contributes no additional meaning or constraints to compensate for the absent schema descriptions.

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 uses a specific verb ('Add') with a clear resource ('comment to a work item'), so an agent can distinguish this from the sibling read tool ado_work_item_comments_list and from work item create/update tools. 'When write mode is enabled' adds a condition but doesn't obscure the action.

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?

It provides one usage condition — write mode must be enabled — which is relevant for deciding whether the tool can run. However, it gives no explicit guidance about when to choose this over ado_work_item_comments_list for reading comments or ado_work_item_update for editing work items, and no exclusions.

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