get_issue_link

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

No annotations are provided, so the description carries the burden of disclosing behavior. It only states 'Get', implying a read operation, but does not describe return format, error behavior, permissions, or any side effects. The description adds no behavioral context beyond what the name already implies.

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 very short, but this is under-specification rather than proper conciseness. It is a three-word phrase that repeats the tool name and lacks any additional useful content. It does not provide a meaningful explanation of the tool's role.

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 getter with one parameter and no output schema, the description should at least clarify what an issue link is and that the return value is the link object. It also does not differentiate from remote issue link tools. The absence of annotations and output schema means the description needs to carry more context, but it carries almost none.

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% because linkId has a clear description. The description itself adds no parameter semantics beyond 'linkId', so the baseline of 3 applies. With only one parameter and a complete schema entry, no further compensation is needed.

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 'Get issue link' is a direct restatement of the tool name with spaces instead of underscores, providing no additional information beyond the name itself. It does not specify that this retrieves a link by its ID nor distinguish it from related siblings like get_remote_issue_link_by_id or get_issue_link_types.

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 gives no guidance on when to use this tool or which alternative to choose. It does not mention scenarios, exclusions, tradeoffs, or sibling comparisons such as retrievin internal issue links vs remote issue links. An agent gets no direction beyond the tool name.

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