get_work_item

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

Does not contradict annotations (readOnlyHint=true). Adds behavioral context about the include_description_html parameter and the caution regarding blanked bodies, which goes beyond the annotation.

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?

Two short sentences, front-loaded with the main purpose. The second sentence, while technical, is relevant. No unnecessary filler.

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?

Covers purpose and key parameter behavior. With an output schema, return values need not be described. However, lacking differentiation from read_work_item and no mention of error handling or permissions leaves some gaps.

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 coverage is 100% with descriptions for all three parameters. The description adds extra meaning for include_description_html, noting it is the required source for update_work_items, enriching the schema baseline of 3.

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?

Description clearly states the tool gets full details of one work item by ID. However, it does not differentiate from sibling 'read_work_item', which may have overlapping functionality.

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?

Explicitly mentions that include_description_html is required for update_work_items and warns against feeding back a blanked body. Provides partial usage guidance but does not contrast with siblings like read_work_item.

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