Skip to main content
Glama

Get maintenance mode status

immich_get_maintenance_status
Read-onlyIdempotent

Check whether Immich is in maintenance mode and retrieve details of the currently running maintenance action.

Instructions

Get maintenance mode status

Fetch information about the currently running maintenance action.

Immich operation: GET /admin/maintenance/status · tag: Maintenance (admin)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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 declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds that it reports on a currently running maintenance action plus the underlying GET endpoint, but says nothing about admin authorization requirements, rate limits, or the shape of the response.

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 with the operation name, then one clarifying sentence, then the endpoint/tag metadata. No filler, though the trailing 'Immich operation' line is largely redundant with the name.

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 zero-parameter read tool whose annotations fully cover the safety profile, the definition is nearly complete. The only gap is that, with no output schema, it doesn't hint at what status fields are returned.

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 there is no parameter semantics to explain; baseline 4 applies. Nothing in the schema or description is ambiguous.

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+resource ('Get maintenance mode status') and reinforces it with 'Fetch information about the currently running maintenance action.' An agent can distinguish this read operation from the write sibling immich_set_maintenance_mode, though the description never names that alternative explicitly.

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 'admin' tag and 'currently running maintenance action' phrasing imply an admin-diagnostic context, but there is no explicit when-to-use, prerequisite, or pointer to immich_set_maintenance_mode. Usage is inferable rather than stated.

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