Skip to main content
Glama

Retrieve calendar heatmap activity

immich_get_my_calendar_heatmap
Read-onlyIdempotent

Retrieve activity counts for a date range as a calendar heatmap. Provide from/to dates (UTC) and type (Upload or Taken) to analyze your Immich activity.

Instructions

Retrieve calendar heatmap activity

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

Immich operation: GET /users/me/calendar-heatmap · tag: Users

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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 only that the response is activity counts in heatmap format; it omits whether the endpoint is scoped to the authenticated user, what happens if from/to are omitted, and any date-range limits.

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?

The text is short and the operation/tag footer is useful for traceability, but the first line is a verbatim repeat of the title before the actual informative sentence, which is mild redundancy rather than wasted space.

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 should describe the return shape, and 'activity counts ... in a calendar heatmap format' is only a sketch. Combined with zero usage guidance for an endpoint whose from/to are optional, an agent has enough to call it but not to interpret or bound the result.

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% with per-parameter descriptions ('Start date in UTC', 'End date in UTC', and an Upload/Taken enum), so the schema carries parameter meaning. The description adds nothing beyond 'specified period', which merely restates the from/to pair, so the baseline 3 applies.

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 ('Retrieve') and resource ('calendar heatmap activity'), then clarifies the payload as activity counts over a period in calendar heatmap format. It does not, however, distinguish itself from the sibling immich_get_user_calendar_heatmap_admin, leaving the reader to infer that this variant is scoped to the caller.

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 explicit when-to-use, when-not-to-use, or alternative guidance. The phrase 'for a specified period' weakly implies the from/to window is the selection mechanism, but nothing tells an agent how this differs from get_time_buckets, get_user_calendar_heatmap_admin, or statistics tools.

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