Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

List session replay recordings

umami_list_replays
Read-onlyIdempotent

List recorded session replays for a website over a date range, newest first. Get session details such as device, browser, country, duration, and event count to locate and inspect user behavior recordings.

Instructions

List recorded session replays for a website over a date range, newest first.

Replays only exist where recording is enabled (umami_get_recorder_config) and a session was sampled. Use umami_get_replay to inspect one in detail.

Args:

  • website (string, optional): Website ID, name, or domain.

  • range (string): Date range, default '7d'.

  • start_date / end_date (string, optional): Explicit bounds, overriding 'range'.

  • page (number): Page number, 1-based (default: 1).

  • page_size (number): Recordings per page, 1-100 (default: 20).

  • response_format ('markdown' | 'json'): Output format (default: 'markdown').

Returns: JSON shape: { "total": number, "page": number, "page_size": number, "replays": [ { "id": string, "session_id": string, "device": string, "browser": string, "os": string, "country": string, "duration_seconds": number, "event_count": number, "started_at": string } ] }

Error handling:

  • An empty result usually means recording is off for this website, or no session was sampled in the range. Check umami_get_recorder_config.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number, 1-based.
rangeNoDate range for the query, default '7d'. Relative ("30m", "24h", "7d", "4w", "3mo", "1y"), named ("today", "yesterday", "this_week", "last_week", "this_month", "last_month", "this_year", "last_year", "mtd", "ytd", "all_time"), or an explicit ISO date via start_date/end_date.
websiteNoWebsite ID (UUID), name, or domain. Optional if UMAMI_DEFAULT_WEBSITE is set. Use umami_list_websites to discover values.
end_dateNoExplicit end date (YYYY-MM-DD, ISO 8601 timestamp, or epoch ms). Overrides 'range'.
page_sizeNoRecordings per page.
start_dateNoExplicit start date (YYYY-MM-DD, ISO 8601 timestamp, or epoch ms). Overrides 'range'.
response_formatNoOutput format: 'markdown' for a readable summary, 'json' for raw structured data.markdown

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the description adds value beyond them by disclosing ordering ('newest first'), the dependency on recording config, and the meaning of empty results. It also provides a detailed return shape and error-handling guidance, which is especially useful since no output schema is present.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-organized with clear sections for behavior, arguments, return shape, and error handling. It front-loads the core purpose and usage guidance, and every section contributes practical information without padding or repetition.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given there is no output schema, the description compensates by including a concrete JSON return shape. It also covers prerequisites, empty-result interpretation, and related tools, making the tool fully usable by an agent without needing additional inference. The description is complete for a read-only listing tool.

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 the schema already documents all seven parameters thoroughly. The description's Args section largely restates the schema rather than adding new semantic detail, but it does reinforce key defaults and the relationship between range and start_date/end_date. This aligns with the baseline of 3 when the schema carries the parameter documentation burden.

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?

The description states a specific verb and resource ('List recorded session replays for a website over a date range, newest first'), making the tool's function immediately clear. It also differentiates from siblings by pointing to umami_get_replay for detailed inspection and implicitly distinguishing replays from general sessions.

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

Usage Guidelines5/5

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

The description explicitly states preconditions ('Replays only exist where recording is enabled...'), names the alternative tool for deeper inspection ('Use umami_get_replay to inspect one in detail'), and explains how to interpret empty results. This gives an agent clear decision criteria for when to call this tool versus alternatives.

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