create_work_item_attachment

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

With no annotations, the description carries the full burden and does disclose a meaningful three-step behavior chain: read from local filesystem, upload to Azure DevOps, link to the work item. It omits preconditions (file must exist, size limits), permission requirements, overwrite/duplicate-name behavior, and what is returned.

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 tight sentences, no filler, with the core action front-loaded and the mechanism following. 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 mutation tool with no annotations and no output schema, the description covers the workflow but leaves gaps: it does not describe what is returned (e.g., attachment ID or link) or failure/permission behavior. Since parameters are fully covered by the schema, the remaining shortfall is mainly behavioral and return-value context.

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 100%, with all four parameters (workItemId, filePath, fileName, comment) fully documented in the schema, so the baseline is 3. The description adds no parameter-level detail beyond the schema, such as path format requirements or how fileName defaults are resolved.

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?

States a specific verb and resource ('Upload a file and attach it to a work item') and distinguishes itself from the read/delete attachment siblings through the create action. The second sentence clarifies the mechanism, so an agent knows exactly what the tool accomplishes.

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 implies when to use it (attaching a local file to a work item) and notes the file is read from the local filesystem, which is a useful precondition hint. However, it never names alternatives such as get_work_item_attachment or delete_work_item_attachment, nor states when not to use it or what permissions are required.

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