Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Get a session replay summary

umami_get_replay
Read-onlyIdempotent

Summarize any recorded session replay with pages visited, click count, and event breakdown instead of raw rrweb streams. Accepts a replay UUID and returns a readable markdown or structured JSON summary.

Instructions

Summarize one recorded session replay: pages visited, click count, and a duration/event breakdown.

This does not return the raw rrweb event stream (it can be tens of thousands of events); it summarizes it. Get replay IDs from umami_list_replays with response_format='json'.

Args:

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

  • replay_id (string, required): Replay UUID.

  • include_clicks (boolean): Include the raw click coordinates (default: false, capped at 200).

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

Returns: JSON shape: { "session_id": string, "pages": [ { "href": string, "at": string } ], "click_count": number, "clicks": [ { "x": number, "y": number, "pathname": string } ] | undefined }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
websiteNoWebsite ID (UUID), name, or domain. Optional if UMAMI_DEFAULT_WEBSITE is set. Use umami_list_websites to discover values.
replay_idYesReplay UUID, from umami_list_replays.
include_clicksNoInclude raw click coordinates, capped at 200.
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.1/5.0
Behavior4/5

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

The annotations already indicate a read-only, idempotent operation. The description adds meaningful behavioral context: output is summarized rather than raw, raw event streams can be tens of thousands of events, and click coordinates are capped at 200. Minor inconsistency: the first sentence promises a 'duration/event breakdown,' but the listed JSON shape does not include duration.

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 description is well-structured and front-loaded: purpose, caveats, args, and return shape are clearly separated. The Args section is somewhat redundant with the schema, but the overall length is reasonable given the lack of an output schema and the need to explain return shape and behavior.

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?

Because there is no output schema, the description appropriately provides a JSON return shape and upstream ID-sourcing instructions. It falls short by not explaining how the default markdown output presents the duration/event breakdown and by omitting any error or edge-case behavior.

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 coverage is 100%, so the schema already fully documents replay_id, website, include_clicks, and response_format. The Args list mostly restates schema content; the only extra parameter-related guidance is the upstream hint to use response_format='json' with umami_list_replays.

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 uses a specific verb ('Summarize') and resource ('one recorded session replay'), then enumerates the summary contents: pages visited, click count, and a duration/event breakdown. It also explicitly distinguishes the tool from raw event-stream access, making its role clear relative to related replay/session tools.

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

Usage Guidelines4/5

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

It clearly states how to obtain replay IDs (from umami_list_replays) and sets a boundary: this tool returns a summary, not the raw rrweb event stream. It does not explicitly name alternative tools for raw events or heatmaps, so some when-not-to-use guidance is implied rather than fully spelled out.

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