Skip to main content
Glama

Update user preferences

immich_update_user_preferences_admin
Idempotent

Update a user's preferences, such as email notifications or sidebar visibility, using the Immich admin API. Provide the user ID and new values.

Instructions

Update user preferences

Update the preferences of a specific user.

Immich operation: PUT /admin/users/{id}/preferences · tag: Users (admin)

DEPRECATED — prefer the replacement operation if one exists.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesformat: uuid
castNocast (request body)
tagsNotags (request body)
albumsNoalbums (request body)
avatarNoavatar (request body)
peopleNopeople (request body)
foldersNofolders (request body)
ratingsNoratings (request body)
downloadNodownload (request body)
memoriesNomemories (request body)
purchaseNopurchase (request body)
sharedLinksNosharedLinks (request body)
recentlyAddedNorecentlyAdded (request body)
emailNotificationsNoemailNotifications (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 readOnlyHint=false, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety/behavioral profile is covered structurally. The description adds the useful facts that this is an admin-scoped endpoint and is deprecated, but says nothing about partial-vs-full update semantics or auth requirements, so it adds only modest context.

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?

It is short and front-loaded, but the title 'Update user preferences' is immediately restated by 'Update the preferences of a specific user', which is redundant filler. The deprecation note is the only non-redundant content, and it is terse.

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 14-parameter admin mutation on nested objects with no output schema, the annotations and rich schema cover most of what an agent needs. However, the description never clarifies whether omitted preference fields are preserved or reset (a key concern for a partial-body PUT) and leaves the 'replacement operation' unnamed, so it is only minimally complete.

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% across all 14 nested preference parameters, so the schema fully documents field meaning. The description adds no parameter-level detail beyond the endpoint signature, which is the correct baseline when the schema does the heavy lifting.

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 specific verb+resource ('Update the preferences of a specific user') and the HTTP operation (PUT /admin/users/{id}/preferences) with an admin tag, which implicitly distinguishes it from the sibling immich_update_my_preferences. It does not explicitly name that sibling, so sibling differentiation is inferred rather than stated.

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?

The deprecation warning ('prefer the replacement operation if one exists') gives a usage signal, but it never names the replacement operation, leaving the agent to guess. There is no guidance on when to choose this admin variant over immich_update_my_preferences, so usage is only weakly implied.

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