Skip to main content
Glama

Retrieve all shared links

immich_get_all_shared_links
Read-onlyIdempotent

Retrieve all shared links from Immich, with optional filters for link ID or album ID, to review and manage shared access.

Instructions

Retrieve all shared links

Retrieve a list of all shared links.

Immich operation: GET /shared-links · tag: Shared links

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoFilter by shared link ID
albumIdNoFilter by album ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the whole safety profile is covered structurally. The description adds only the raw HTTP mapping (GET /shared-links) and tag, with no pagination behavior, result-set size, or permission context beyond what annotations supply.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded, but wasteful: 'Retrieve all shared links' and 'Retrieve a list of all shared links' say the same thing in two consecutive lines. The endpoint/tag line is compact and useful metadata, but the redundant first sentence does not earn its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a parameterless-required, read-only listing tool with full annotation coverage and no output schema, the description is minimally sufficient. It omits whether results are paginated or capped and does not clarify whether an unfiltered call returns all links or a page, which matters for a 'get all' tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so id ('Filter by shared link ID') and albumId ('Filter by album ID') are already fully documented in the schema. The description adds no filtering semantics on top, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear verb and resource: 'Retrieve a list of all shared links.' An agent knows this is a read of the shared-links collection. It does not, however, distinguish itself from near siblings such as immich_get_shared_link_by_id, immich_get_my_shared_link, or immich_update_shared_link.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use guidance, no exclusions, and no pointer to alternatives like get_shared_link_by_id for a single link. The optional id/albumId filters exist in the schema but are never framed as the reason to choose this tool over the by-id variant.

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

Deploy Server

Other Tools