Update work item

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

Annotations already establish readOnlyHint=false, idempotentHint=true, and destructiveHint=false. The description adds useful behavioral context beyond those: the update uses JSON Patch, state and assignedTo are mandatory even though other fields are optional, and the tool returns the updated work item. This is meaningful given there is no output schema, though it does not discuss edge cases like failed state transitions.

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 two tight sentences with no filler. It front-loads the operation ('Update a work item's metadata'), specifies the method ('via JSON Patch'), states the mandatory fields, and closes with the return value. Every sentence 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?

For a ­17-param­eter mutation tool with no output schema, the descrip­tion covers the return value but does not address the exis­tence of update_work_i­tems (batch) or explain when the single-item update should be preferred. The rich input schema mitigates param­eter gaps, but the missing sibling routing and minimal behavioral caveats leave the descrip­tion function­ally adequate yet incomplete.

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 82%, so the schema already documents most parameters. The description adds aggregate guidance by naming state and assignedTo as mandatory and calling other fields optional, but it omits the required id from that statement, which could slightly mislead. It does not add per-parameter meaning beyond what the schema provides.

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 states a specific verb and resource: 'Update a work item's metadata via JSON Patch.' It distinguishes the tool from read/get siblings and from the plural update_work_items by making the singular 'a work item' explicit. However, it does not explicitly name or contrast the sibling update_work_items, so it stops short of full sibling differentiation.

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 update_work_items or other sibling tools. It mentions that state and assignedTo are mandatory, which is a prerequisite rather than usage context. There are no when-to-use, when-not-to-use, or alternative-tool signals.

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