Skip to main content
Glama

Share album with users

immich_add_users_to_album
Idempotent

Share an Immich album with multiple users at once, assigning each a viewer, editor, or owner role. Grants album access and permissions in a single API call.

Instructions

Share album with users

Share an album with multiple users. Each user can be given a specific role in the album.

Immich operation: PUT /albums/{id}/users · tag: Albums

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesformat: uuid
albumUsersYesalbumUsers (request body)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, readOnlyHint=false and openWorldHint=true, so the safety profile is covered. The description adds only that multiple users are affected and that each carries a role, without noting auth requirements or behavior on duplicate/re-shared users, so it adds modest value over the annotations.

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 body opens by repeating the title verbatim ('Share album with users'), which wastes the most prominent line, though the remaining sentences and the operation/tag footer are compact and front-loaded enough to be usable.

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 two-parameter mutation with no output schema and full annotation coverage, the description supplies the action, the scope (multiple users), the role concept, and the underlying endpoint, leaving little that an agent needs missing.

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 the required id and albumUsers (with the role enum) are already documented in the schema. The description restates that a role is assignable per user but contributes no format, syntax, or constraint detail beyond the schema, making the baseline 3 correct.

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?

States a specific verb and resource ('Share an album with multiple users') and adds the REST operation (PUT /albums/{id}/users). It clearly distinguishes itself from the add/remove-asset siblings, though it does not explicitly name the closest counterpart, immich_update_album_user, which changes roles rather than adding users.

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 implied by the verb 'share' and the note that users can be given roles, but there is no explicit when-to-use guidance, no prerequisites, and no direction to sibling tools such as immich_update_album_user or immich_remove_user_from_album.

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