Skip to main content
Glama

List shared links

list_shared_links
Read-only

Lists all public shared links in your Immich library, returning each link's ID, type, description, and album details so you can review public shares or find IDs for updates and deletion.

Instructions

List all shared links (public gallery URLs). Use this to see what's currently shared publicly or to find a link ID for updates/deletion. Read-only.

Returns: JSON with total count and links array (each with id, key, type, description, album info).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_shared_links"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.1/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true and destructiveHint=false, and the description's "Read-only." merely restates that rather than adding new context. The return-shape sentence describes the payload, but an output schema exists, so that information is already structured data; no pagination behavior, result limits, or visibility/permission caveats are disclosed.

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

Conciseness4/5

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

Three short sentences, front-loaded with the purpose before the usage hint, with no filler. The trailing "Returns:" sentence and the "Read-only" fragment are partially redundant with the output schema and annotations, which keeps it from a 5.

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

Completeness4/5

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

For a zero-argument, read-only list tool with an output schema and supporting annotations, the description covers purpose and usage adequately. The only remaining gap is scale behavior (whether the full list is always returned, or whether large accounts hit limits), which is not addressed anywhere.

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

Parameters4/5

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

The tool takes zero parameters, so the baseline is 4 and there is no parameter meaning that could be added or omitted. The description correctly implies an unfiltered enumeration of all links, which matches the empty schema.

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

Purpose5/5

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

The description pairs a specific verb ("List all") with a concrete resource ("shared links (public gallery URLs)"), even parenthetically glossing what a shared link is so the agent does not have to infer it. It is distinguishable from the singular siblings get_shared_link, update_shared_link, and delete_shared_link by the explicit "all" scope and by naming updates/deletion as downstream uses.

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

Usage Guidelines4/5

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

It gives two concrete situations for calling it: auditing what is currently public, and obtaining a link ID before an update or delete. It does not state any when-not condition or name an alternative listing tool, but with zero parameters and no close sibling that also enumerates links, the guidance is effectively sufficient.

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