Skip to main content
Glama

Retrieve calendar heatmap activity

immich_get_user_calendar_heatmap_admin
Read-onlyIdempotent

Fetch an Immich user's calendar heatmap activity counts by date range and type (Upload or Taken) to visualize daily activity for admins.

Instructions

Retrieve calendar heatmap activity

Retrieve activity counts for a specified period, in a calendar heatmap format.

Immich operation: GET /admin/users/{id}/calendar-heatmap · tag: Users (admin)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesformat: uuid
toNoEnd date in UTC
fromNoStart date in UTC
typeNoType of calendar heatmap

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is covered. The description adds that this is an admin-scoped operation and exposes the backing route, implying elevated permissions, but says nothing about auth requirements, rate limits, or output shape. Adequate but not rich.

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, but the first line merely repeats the title before the substantive second sentence, so a small amount of space is wasted. Slightly redundant but overall efficient.

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 read-only stats endpoint with four fully documented parameters and a complete annotation safety profile, this is close to sufficient; it even sketches the return concept ('activity counts in calendar heatmap format'). It could do more on admin authorization and the date-range semantics when from/to are omitted, but no output schema means little else is required.

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% (id, to, from, type each documented, type has an enum). The description only alludes to 'a specified period', adding no syntax, default, or interpretation beyond what the schema already provides. Baseline 3 is correct.

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 ('Retrieve') and resource ('calendar heatmap activity') plus the admin route GET /admin/users/{id}/calendar-heatmap. It is clear what the tool returns, but it never distinguishes itself from the sibling immich_get_my_calendar_heatmap, leaving the 'admin/user-id vs. self' distinction implicit.

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?

The description gives no when-to-use guidance, no prerequisites, and no alternatives. The existence of immich_get_my_calendar_heatmap as a sibling means an agent would benefit from knowing this endpoint is for arbitrary users vs. the caller, but nothing is 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