Skip to main content
Glama
arttus

umami-mcp-server

by arttus

Get the live session replay / heatmap config

umami_get_recorder_config
Read-onlyIdempotent

Get the actual recorder configuration Umami serves to the tracker for a website, confirming replay and heatmap settings, sample rates, masking level, max duration, and block selector.

Instructions

Get the recorder configuration Umami is actually serving to the tracker for a website: whether replay and heatmaps are enabled, sample rates, masking level, max duration, and the block selector.

This reads the same public endpoint the tracker script itself calls, so it is the ground truth after umami_update_website changes replay or heatmap settings, useful for confirming values actually took effect and resolving any unit ambiguity on max duration.

Args:

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

Returns: JSON shape: { "enabled": boolean, "replay_enabled": boolean, "heatmap_enabled": boolean, "sample_rate": number, "heatmap_sample_rate": number, "mask_level": string, "max_duration": number, "block_selector": string }

Examples:

  • "Did the replay settings actually save?" -> website="example.com"

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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already indicate readOnly, idempotent, and non-destructive behavior. The description adds meaningful context beyond that: it reads the same public endpoint as the tracker, making it ground truth, and clarifies that it resolves unit ambiguity on max duration. No contradiction with annotations.

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-structured and every section earns its place: a precise summary, a rationale for using it, an Args block, a Returns block with the JSON shape, and a concrete example. It is front-loaded with the core purpose and contains no filler.

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?

With no output schema present, the description compensates by documenting the exact JSON return shape. The tool is simple, has one optional parameter, and its typical use case is explained clearly. Nothing an agent needs to select and invoke this tool correctly is missing.

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?

The schema already fully documents the optional website parameter (ID, name, or domain) and notes the default website fallback. The description repeats this and gives an example, but adds no new semantic detail such as accepted formats, units, or edge cases. Because schema coverage is 100%, baseline 3 is appropriate.

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: 'Get the recorder configuration Umami is actually serving to the tracker for a website.' It enumerates the exact config fields returned, which makes the tool's scope unmistakable and clearly distinguishes it from analytics and heatmap data siblings like umami_get_click_heatmap.

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?

The description gives clear context for when to use it: as the ground truth after umami_update_website changes, to confirm values took effect and resolve unit ambiguity. It does not explicitly list when not to use it or name alternative tools, so it falls just short of fully explicit routing.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.