remove_issue_link

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

The description indicates a destructive action (removing a link) but does not elaborate on any side effects, permissions needed, or whether the operation is reversible. With no annotations, more detail would be beneficial.

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 that provides the essential information without any unnecessary words or fluff.

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 tool with one parameter and no output schema, the description is minimally adequate. However, it could be improved by explaining what a link ID is or how to obtain it, and by mentioning any confirmation or rollback behavior.

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 only parameter 'linkId' is described in the schema as 'The link ID to remove', and the description adds no additional meaning. Since schema coverage is 100%, the description does not need to compensate but also does not enhance understanding.

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 verb 'Remove' and the specific resource 'a link between two Jira issues', making it distinct from sibling tools like create_issue_link.

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 link needs to be removed) but does not provide explicit guidance on when to use this tool versus alternatives or any exclusions. It lacks context about prerequisites or related tools.

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