Skip to main content
Glama

Unlock auth session

immich_unlock_auth_session

Temporarily grant a locked Immich auth session elevated access by submitting the correct PIN code or password, enabling management of locked assets.

Instructions

Unlock auth session

Temporarily grant the session elevated access to locked assets by providing the correct PIN code.

Immich operation: POST /auth/session/unlock · tag: Authentication

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pinCodeNopinCode (request body)
passwordNopassword (request body)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), so the bar is lower. The description adds the meaningful behavioral fact that the elevation is temporary and PIN-gated, but does not say how long the elevation persists, whether a logged-in session is required, or what happens on a wrong PIN.

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?

Short and front-loaded: the action, then the effect, then the raw operation metadata. The 'Immich operation: POST ...' trailer is machine-derived but useful for disambiguation; nothing is padded.

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 only two optional params, the description is nearly sufficient, but it leaves open whether pinCode or password is the correct credential and what the temporary unlock actually enables downstream. Adequate but with clear gaps.

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 both pinCode and password are documented in the schema, giving a baseline of 3. The description mentions only the PIN code and gives no format, length, or guidance on which of the two credentials to send, so it adds little beyond the 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?

States a specific verb (unlock) on a specific resource (auth session) plus the concrete effect: temporarily granting elevated access to locked assets via a PIN. An agent can distinguish it from lock_auth_session, lock_session, and end_session without opening the schema.

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 description implies the prerequisite (a correct PIN code must be supplied) and the situation (assets are locked and need elevated access), but it never names alternatives such as lock_auth_session/lock_session or states when-not to use this tool. Usage is inferable rather than explicit.

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