add_external_link

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

The description adds valuable behavioral context beyond the annotations: repeated calls with the same external_id return the existing link instead of creating a duplicate. This clarifies the idempotency behavior that idempotentHint only hints at. No contradiction with annotations exists.

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 sentences and both are purposeful: the first states exactly what the tool does and to which systems, and the second covers an important behavioral caveat. No filler 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, combined with the rich schema and annotations, is largely complete: scope, idempotency, and entity/provider flexibility are all covered. The only notable gap is that the happy-path return value is not described, and there is no output schema to compensate.

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 86%, so the schema already carries most parameter semantics, setting the baseline at 3. The description does not meaningfully add to individual field meanings, although the idempotency note does clarify the function-level semantics of externalId.

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: 'Link any test entity... to an external ticket...'. It explicitly enumerates entity types and target systems, which clearly distinguishes it from sibling tools like link_launches_to_release or link_autotest_to_case.

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 context is clear: use this tool when adding an external link to an entity. However, it does not explicitly differentiate when to use this tool versus alternatives such as list_external_links or remove_external_link, nor does it provide any exclusions or when-not-to-use guidance.

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