Skip to main content
Glama

Retrieve download information

immich_get_download_info

Retrieve download information for selected assets or an album, including grouped assets that can be downloaded together.

Instructions

Retrieve download information

Retrieve information about how to request a download for the specified assets or album. The response includes groups of assets that can be downloaded together.

Immich operation: POST /download/info · tag: Download

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNo
slugNo
userIdNouserId (request body)
albumIdNoalbumId (request body)
assetIdsNoassetIds (request body)
archiveSizeNoarchiveSize (request body)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare the safety profile (destructiveHint=false, openWorldHint=true, idempotentHint=false). The description adds useful context about the return shape (asset groups downloadable together) but says nothing about auth requirements, rate limits, or why a 'retrieve' posts readOnlyHint=false — the read-only intent implied by 'Retrieve' is mildly at odds with the annotation.

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?

The opening line duplicates the title verbatim before restating the same idea ('how to request a download'), which is redundant. The remaining sentences are efficient, but the front-load is wasted on the repeat.

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?

With no output schema and six loosely documented parameters, the description only briefly sketches the return value ('groups of assets that can be downloaded together'). It is enough to understand the general purpose but not the payload structure or how to consume the groups.

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 coverage is 67%, so the schema documents userId/albumId/assetIds/archiveSize as generic 'request body' entries. The description narrows the choice by saying the request targets 'assets or album,' mapping to assetIds/albumId, but the key and slug parameters remain undocumented anywhere.

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 names a specific verb (retrieve) and resource (download information) and clarifies the payload: 'groups of assets that can be downloaded together.' That distinguishes it from siblings like immich_download_archive/immich_download_asset, which actually fetch files, though the differentiation is implied rather than explicit.

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

Usage Guidelines3/5

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

Usage is only implied: 'how to request a download for the specified assets or album' suggests this is the lookup step preceding an actual download. There is no explicit when-to-use, no prerequisites, and no naming of the alternative download tools an agent should pick after calling this.

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