retrieve_work_item_link

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

With no annotations, the description only discloses that it returns a WorkItemLink object and takes UUID parameters. It does not mention error behavior, required permissions, or that this is a harmless read operation, leaving the agent to infer safety and failure modes.

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 compact, with a one-line purpose and structured Args/Returns sections. It avoids unnecessary wording while covering the essential information.

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 simple retrieval tool, the description covers the operation, inputs, and return type, and an output schema exists. However, it lacks usage guidance and behavioral details such as error cases, making it only minimally complete.

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 description provides semantic context for all three parameters beyond the schema's bare string types, explaining that project_id, work_item_id, and link_id are UUIDs of their respective entities. This meaningfully compensates for the 0% schema description coverage.

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 clearly states 'Retrieve a specific link for a work item' with a specific verb and resource, and includes the link_id parameter to clarify it targets a single item. This distinguishes it from sibling tools like list_work_item_links, which retrieves multiple links.

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 usage when a specific link is needed by requiring link_id, but it does not explicitly contrast with list_work_item_links or mention when not to use it. This is minimal but at least conveys the single-item scope.

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