link_execution_defects

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

Without annotations, the description must disclose all behavioral traits. It reveals the async operation and polling via the 'wait' parameter, but does not mention prerequisites, idempotency, error handling, or side effects of linking defects.

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 two concise sentences followed by a brief listing of parameters and behavior. Essential information is front-loaded, with no redundant or extraneous content.

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 complexity (async, polling) and lack of output schema, the description covers the main workflow but does not specify the exact return format when 'wait=True' (e.g., success/error response) or behavior on token expiration.

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 carries the full burden. It explains that 'executions' are IDs, 'defects' are Jira keys, 'wait' controls synchronous vs async behavior, and 'timeout' sets polling duration. This adds significant meaning beyond the schema's type-only definitions.

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 the tool links Jira defects to executions, specifying the asynchronous nature and polling mechanism. It distinguishes itself from sibling tools like 'list_execution_defects' and 'assign_execution' by focusing on linking multiple defects to multiple executions.

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 explains the wait parameter and polling behavior, but does not provide explicit guidance on when to use this tool versus alternatives like 'assign_execution' or 'get_executions_by_defect'. Usage context is implied rather than explicitly stated.

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