create_work_item_comments

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

Discloses key behaviors: non-idempotent (retry duplicates), HTML unsanitized, default author behavior. Annotations lacked these details, so description adds significant value.

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 very concise, front-loaded with purpose, and every sentence adds value. No extraneous words.

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?

With output schema present, return values need not be explained. Covers behavior, parameter hints, and idempotency. Lacks error conditions or permissions, but sufficient for a creation tool.

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 100% schema description coverage, the description enriches parameter meanings: instructs to use short ID from list_work_item_comments for parent_comment_id, explains text_format implications, and author_id omission. Adds practical semantics beyond 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 the verb ('create'), resource ('comments on a work item'), and scope ('one or more in a single request'). It distinguishes from siblings like 'create_document_comments' (for documents) and 'update_work_item_comment' (for updates).

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 specific guidance on setting parent_comment_id, using title, handling HTML unsanitized, and omitting author_id for token user. Does not explicitly contrast with alternatives but the hints are clear enough.

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