Update Work Item

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

Annotations already indicate it is a write operation (readOnlyHint=false) and not destructive. The description adds little beyond listing fields; it does not disclose required permissions, side effects, or behavior when only a subset of fields is provided.

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 a single concise sentence that front-loads the verb 'Update' and lists the attributes. It is efficient but could benefit from structure (e.g., bullet points) to improve readability given the long list.

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's complexity (26 parameters, 0% schema coverage, no output schema), the description is incomplete. It does not mention partial update behavior, the requirement of project context, or what the response contains, leaving the agent with many unknowns.

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. However, it only provides a high-level category list (e.g., 'custom fields', 'dates') without explaining specific parameter semantics like state_event values, custom_fields structure, or the difference between add_labels and remove_labels.

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 'Update' and enumerates the specific attributes that can be modified, such as title, description, labels, etc. However, it does not explicitly distinguish this tool from sibling tools like convert_work_item_type or move_work_item, which also modify work items.

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?

No guidance is provided on when to use this tool versus alternatives, nor are there any preconditions or exclusions mentioned. The description merely lists updatable fields without contextual usage advice.

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