Get work item audit history

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

With no annotations provided, the description bears the full burden of behavioral disclosure. It only states that the tool lists updates and changes, which implies a read-only operation, but it does not mention pagination (top/skip), project scoping, authentication requirements, or the structure of the returned data. An agent cannot anticipate behavior beyond the basic list semantics.

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 with no wasted words. It is front-loaded with the action and resource, but it lacks any additional structure such as examples or parameter hints. While efficient, it could be slightly improved with a note about pagination or usage context without losing conciseness.

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 has four parameters, no annotations, and no output schema, the description is far from complete. It omits pagination details, project usage, return format, and any caveats about historical data. An agent cannot safely call this tool without additional external knowledge about Azure DevOps API conventions.

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 for the undocumented parameters. It does not explain that 'top' and 'skip' control pagination, that 'project' scopes the query, or even that 'workItemId' is the identifier for the work item. The description adds no semantic value to any parameter, leaving the agent to guess from names alone.

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 uses the specific verb 'List' and names the exact resource and content: 'revision updates and field/relation changes for a work item.' This clearly distinguishes it from siblings like get_work_item (current state) and get_work_item_comments (comments), even without naming alternatives. The purpose is unambiguous.

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 about when to use this tool versus the many sibling work-item tools. It does not mention that this is for historical audit data, nor does it suggest using get_work_item for current state or query_work_items for search. The usage context is entirely left to the agent to infer.

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