Get Work Item

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

Annotations already cover readOnly/openWorld/idempotent, so the description's added value is moderate. It mentions 'Defaults to the configured test project,' which is useful context, but it fails to clarify how the tool receives an 'ID or name' given the input schema is empty.

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 sentences and every clause adds value: the operation, the usage guidance, and the default project. No fluff or redundancy.

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?

The description conveys the single-item scope, the recommended workflow, and the default project, which is substantial for a simple read tool. However, the empty input schema and missing return-format info leave some ambiguity about how the ID is provided and what exactly is returned.

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?

With zero parameters in the schema, the baseline is 4. The description adds the concept of 'by ID or name,' providing some semantic meaning about how the target is selected, though it is not formally mapped to a parameter.

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 uses a specific verb and resource: 'Get a single work item by ID or name.' It clearly distinguishes from workitem_query (list) and workitem_batch_get (multiple) by emphasizing 'single' and 'detail reads'.

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?

Provides explicit usage context: 'Use this for detail reads after resolving a work_item_id from workitem_query or workitem_batch_get.' Names the alternative tools and defines the sequencing, making it clear when to use this tool.

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