AzureDevops_RunWorkItemQuery

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

No annotations are provided, so the description carries full responsibility for behavioral disclosure. It only states that it runs a query, without describing output format, pagination, error handling, or whether it is read-only. This is insufficient for an agent to fully anticipate effects.

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, direct sentence with no redundant words. It is front-loaded and immediately communicates the tool's function.

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 tool has no output schema and no annotations, leaving the description as the only behavioral guidance. It is too minimal to be fully actionable; it does not explain the query syntax requirements, the meaning of 'top', or what a successful result contains. An agent would need to rely on the schema alone.

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?

The input schema provides descriptions for all three parameters (top, query, project), giving 100% coverage. The description itself adds no extra parameter context, but the schema already handles parameter semantics, so the baseline of 3 applies.

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 'Run a WIQL (Work Item Query Language) query' clearly states the specific action and resource, using a verb+resource structure. It does not explicitly differentiate from sibling tools like AzureDevops_SearchCode or AzureDevops_MyWorkItems, but naming WIQL is sufficiently specific for an Azure DevOps work item context.

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?

There is no guidance on when to use this tool versus alternatives such as AzureDevops_MyWorkItems or AzureDevops_GetWorkItem. The description does not mention prerequisites, typical use cases, or exclusions.

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