Skip to main content
Glama

Get product key

immich_get_server_license
Read-onlyIdempotent

Check whether an Immich server currently has a product key registered. Use this to verify server license status via GET /server/license.

Instructions

Get product key

Retrieve information about whether the server currently has a product key registered.

Immich operation: GET /server/license · tag: Server

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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, idempotentHint, and destructiveHint=false, so the safety profile is covered. The description adds the useful behavioral detail that the call reports whether a product key is registered, but says nothing about required permissions or the nature of the returned license data.

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, with the operative sentence immediately after the title line. The repeated title line and the trailing 'GET /server/license · tag: Server' metadata are mildly redundant but not harmful.

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, the description carries more burden, yet it only says the response concerns whether a product key exists, without indicating fields such as license validity or expiry. For a simple zero-param read this is adequate but leaves the return shape underspecified.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so per the rubric the baseline is 4. The description appropriately does not invent parameter discussion for a parameterless call.

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 and resource: retrieve whether the server currently has a product key registered, which is more precise than the bare title. It does not explicitly distinguish itself from close siblings like immich_set_server_license or immich_delete_server_license, though the get/set/delete verb pattern makes the distinction reasonably inferable.

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

Usage Guidelines2/5

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

There is no statement of when to call this versus alternatives, no prerequisites, and no mention that license endpoints typically require admin privileges. The agent must infer usage from the endpoint path and tag alone.

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