tfs_add_work_item_comment

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

The description only states the action 'Add a comment' without disclosing any behavioral traits such as idempotency, permission requirements, side effects, or success/failure behavior. With no annotations provided, the description carries the full burden of transparency but fails to address these aspects.

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 concise at six words, but it sacrifices necessary detail. While brevity is valued, the omission of parameter explanations and usage context makes it too sparse for a tool with three parameters and no schema descriptions.

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 tool has three parameters, no schema descriptions, no output schema, and no annotations, the description is insufficient. It does not explain required inputs, return values, or constraints, leaving the agent without enough context to use the tool reliably.

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?

The input schema has 0% description coverage, and the tool description does not explain any of the three parameters (id, text, project). Without any semantic context, the agent must infer parameter meaning solely from names, which is insufficient for proper invocation.

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 'Add' and the resource 'a comment to a work item,' which precisely identifies the tool's function. It is distinct from sibling tools like tfs_query_work_items or tfs_create_work_item, which deal with different operations.

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 description provides no guidance on when to use this tool versus alternatives, nor does it mention prerequisites or exclusions. For instance, it does not specify that the work item must exist or that this tool is for adding new comments rather than editing existing ones.

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