Skip to main content
Glama

Create user profile image

immich_create_profile_image

Upload and set a new profile image for the current Immich user. Simplifies updating user avatars via the API.

Instructions

Create user profile image

Upload and set a new profile image for the current user.

Immich operation: POST /users/profile-image · tag: Users

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fileYesfile (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 readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=true, so the mutation/safety profile is covered. The description adds that the image is set for the current user, but does not state whether a previous image is replaced or removed, which is the key behavioral question for this endpoint.

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?

Front-loaded one-line summary followed by a clarifying sentence and an operational pointer (POST /users/profile-image). Nothing is padded; the only minor redundancy is the title repeating the first line.

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 simple one-parameter mutation with no output schema, the definition is close to adequate, but it omits practical details an agent needs: the upload encoding of the required 'file' parameter and the effect on any existing profile image.

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 100%, so baseline is 3, but the schema's only description is the tautological 'file (request body)'. The description adds 'Upload' implying a file upload, yet gives no format guidance (binary/multipart, accepted image types, size limits) for what is a non-trivial upload parameter.

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 (create/set) and resource (profile image) with clear scope ('for the current user'), which distinguishes it from the sibling get_profile_image and delete_profile_image. It does not explicitly name siblings, but the action is unambiguous.

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 phrase 'for the current user' implies the usage context, and 'set a new profile image' implies replacing the existing one, but there is no explicit when-to-use vs alternatives guidance (e.g., contrast with upload_asset or update_my_user).

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