Retrieve a shared link

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is fully covered elsewhere. The description adds only the underlying HTTP route and tag (GET /shared-links/{id} · tag: Shared links), which is mild debugging value but no auth, error, or not-found behavior context.

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?

It is short and front-loaded, but wastes a line restating the title verbatim before the slightly more informative sentence, and then appends an API-route/tag line. Roughly half the content is duplication of the title or of the schema.

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 read tool with full annotations and complete schema coverage, the essentials are present. However, there is no output schema, so the description could have said what a shared link object contains or noted auth requirements; it leaves the return shape entirely unspecified.

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% and the single parameter is documented as format: uuid in the schema. The description contributes only the redundant 'by its ID' phrasing, adding no format, validation, or lookup semantics beyond the schema.

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 a specific verb and resource ('Retrieve a specific shared link by its ID'), so the agent knows it fetches one entity. It does not name or distinguish itself from the obvious siblings immich_get_all_shared_links or immich_get_my_shared_link, leaving that differentiation to inference from the 'by its ID' phrasing.

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?

There is no explicit when-to-use statement, no prerequisites, and no named alternatives. The phrase 'by its ID' weakly implies usage only when an ID is already known, but the agent gets no guidance on choosing this over immich_get_all_shared_links or immich_get_my_shared_link.

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