list_issue_links

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

Annotations already declare readOnlyHint, and the description reinforces it ('does not mutate GitLab data') while adding error behavior for missing resources, invalid identifiers, insufficient permission, and rate limits. This is useful behavioral context beyond annotations, though it doesn't describe response shape or pagination.

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 core purpose is front-loaded in the first sentence, and all three sentences contribute. The 'project_id or group_id' conditional and mention of pagination fields are slightly off-target for this schema, which only has project_id and no pagination parameters, causing minor noise.

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 straightforward two-parameter read-only list operation, the description is largely complete: purpose, list-vs-get usage, error behavior, and identifier guidance are all present. The off-target conditional and undocumented pagination reference prevent it from being fully coherent.

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 schema covers both required parameters with descriptions, so the description does not need to document them. It adds a small clarification about numeric IDs vs URL-encoded paths, but most of that repeats schema text, keeping it at the baseline for high schema 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?

States the exact operation ('List all issue links') and target ('specific issue'), and contrasts with the get_issue_link sibling for single-resource inspection. No ambiguity about which sibling to pick.

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?

Explicitly instructs to use for a collection of resources and to choose the corresponding get tool when a single resource is known. This directly maps to the list-vs-get distinction among siblings and leaves no inference required.

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