create_work_item_comment

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

Annotations provide readOnlyHint=false and destructiveHint=false, but the description adds minimal behavioral context beyond stating it creates a comment. It does not disclose idempotency, rate limits, or what happens with conflicting parameters like comment_html and comment_json.

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 structured as a docstring with a clear first sentence stating purpose, followed by a parameter list. It is concise without unnecessary words. The parameter list is needed due to zero schema coverage, so it earns its place.

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 7 parameters, output schema, and is a mutation in a complex API, the description is incomplete. It does not explain parameter interactions (e.g., comment_html vs comment_json), required permissions, or validation rules. Lacks context for effective use.

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 compensate. It provides basic meanings for all 7 parameters (e.g., 'UUID of the project', 'Access level for the comment (INTERNAL or EXTERNAL)'). However, it lacks details on constraints, usage patterns, or parameter interactions.

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' and the resource 'comment for a work item'. It aligns with the tool name and distinguishes from sibling CRUD operations like update, delete, list.

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 (e.g., update_work_item_comment for editing). It does not mention prerequisites or exclusion criteria. Sibling names imply usage but description lacks explicit context.

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