Skip to main content
Glama
arttus

umami-mcp-server

by arttus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Update a website's configuration

umami_update_website
Idempotent

Update website name, domain, public share link, and session replay or heatmap settings. Configure sampling, PII masking, recording duration, and excluded elements; omitted fields stay unchanged.

Instructions

Update a website's name, domain, public share link, or full session replay and heatmap configuration.

Covers every field Umami exposes for a website's recording setup, not just the on/off switches: sampling rates, PII masking strictness, max recording length, and a CSS selector to exclude sensitive elements (payment forms, etc.) from capture. Pass only the fields you want to change; anything omitted is left as-is. Use umami_get_recorder_config afterward to confirm exactly what the tracker will receive.

Args:

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

  • name (string, optional): New display name.

  • domain (string, optional): New domain.

  • share_id (string, optional): Set a custom share slug to enable a public dashboard link. Pass an empty string to disable sharing.

  • replay_enabled (boolean, optional): Enable or disable session replay recording.

  • heatmap_enabled (boolean, optional): Enable or disable heatmap data collection.

  • sample_rate (number, optional): Fraction of sessions to record for replay, 0 to 1.

  • heatmap_sample_rate (number, optional): Fraction of sessions to record for heatmaps, 0 to 1.

  • mask_level ('strict' | 'moderate', optional): PII masking strictness for replay recordings. 'strict' masks more aggressively.

  • max_duration_ms (number, optional): Maximum length of a single recording, in milliseconds. Umami's own docs are inconsistent about whether this field is ms or seconds; umami_get_recorder_config after saving shows the effective value the tracker will actually use.

  • block_selector (string, optional): CSS selector for elements to exclude entirely from replay capture, e.g. '.payment-form, [data-sensitive]'.

Returns: JSON shape: { "id": string, "name": string, "domain": string, "share_id": string | null, "replay_config": { "replayEnabled": boolean, "heatmapEnabled": boolean, "sampleRate": number, "heatmapSampleRate": number, "maskLevel": string, "maxDuration": number, "blockSelector": string } | null }

Examples:

  • "Turn on session replay for the Gradeline site at 20% sampling" -> replay_enabled=true, sample_rate=0.2

  • "Enable heatmaps too, sampled lighter than replay" -> heatmap_enabled=true, heatmap_sample_rate=0.1

  • "Mask more aggressively and exclude the payment form from recordings" -> mask_level="strict", block_selector=".payment-form"

  • "Give this site a public share link" -> share_id="lha-public-dashboard"

  • "Turn off the public link" -> share_id=""

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoNew display name.
domainNoNew domain.
websiteNoWebsite ID (UUID), name, or domain. Optional if UMAMI_DEFAULT_WEBSITE is set. Use umami_list_websites to discover values.
share_idNoCustom share slug to enable a public dashboard link. Empty string disables sharing.
mask_levelNoPII masking strictness for replay recordings.
sample_rateNoFraction of sessions to record for replay, 0 to 1.
block_selectorNoCSS selector for elements to exclude entirely from replay capture.
replay_enabledNoEnable or disable session replay recording.
heatmap_enabledNoEnable or disable heatmap data collection.
max_duration_msNoMaximum length of a single recording, in milliseconds.
heatmap_sample_rateNoFraction of sessions to record for heatmaps, 0 to 1.

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?

Goes well beyond the annotations by disclosing the partial-update semantics ('Pass only the fields you want to change; anything omitted is left as-is'), the empty-string behavior for disabling share links, and the max_duration_ms units inconsistency with a concrete verification path. This is exactly the kind of behavioral context an agent needs.

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 with opening scope, Args, Returns, and Examples sections, and it front-loads the core purpose. It is somewhat long and the Args block partly restates the schema, but the added caveats and examples earn most of the length.

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?

For an 11-parameter update tool with no output schema, the description supplies the return JSON shape, partial-update behavior, field-by-field semantics, examples, and a recommended post-action verification step. An agent has everything needed to invoke it correctly and confirm the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Though the schema covers 100% of parameters, the description adds real value with concrete examples (sample_rate=0.2, heatmap_sample_rate=0.1, block_selector='.payment-form, [data-sensitive]'), the empty-string disabling behavior for share_id, and the max_duration_ms caveat. It also maps natural-language requests to specific argument values, which is highly useful for an agent.

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?

States a specific verb ('Update'), a clear resource ('a website's configuration'), and enumerates the exact fields affected, which distinguishes it from create/delete/get siblings. The description also clarifies that it covers both simple toggles and advanced recording configuration, leaving no ambiguity about what the tool does.

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?

Explains when to use it (to change existing website configuration), how to identify the target website via ID/name/domain, and points to umami_list_websites for discovery and umami_get_recorder_config afterward to verify. It does not explicitly state when not to use it versus umami_create_website or umami_delete_website, so it falls just short of a 5.

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