Umami MCP Server
Umami MCP-Server
Schreibgeschützter MCP-Server für Umami-Analysen. Er kommuniziert direkt über HTTP mit der Umami-REST-API, unterstützt primär selbst gehostetes Umami und funktioniert auch mit Umami-Cloud-API-Schlüsseln.
Dieses Repository wurde so konzipiert, dass übergeordnete Agenten Analysedaten abrufen können, ohne jedes Mal die Umami-Dokumentation lesen zu müssen. Keine Browser-Automatisierung, kein DOM-Scraping, keine Schreibvorgänge.
Funktionen
Schreibgeschützte MCP-Tools für die gängigsten Umami-Analyseabfragen
Zwei Authentifizierungsmodi:
UMAMI_API_KEYUMAMI_USERNAME+UMAMI_PASSWORD
Zwischenspeicherung des Bearer-Tokens im Arbeitsspeicher bei selbst gehosteten Instanzen
Automatische erneute Anmeldung und ein Wiederholungsversuch bei
401im Benutzername/Passwort-ModusAkzeptiert sowohl ISO-Zeitzeichenfolgen als auch Zeitstempel in Millisekunden
Gemeinsame Filterbehandlung für Statistiken, Seitenaufrufe, Aufschlüsselungen und Ereignisserien
Strenges TypeScript mit kleinen, wartbaren Modulen
Klare, strukturierte Tool-Ausgabe und explizite Fehlerkategorien
Related MCP server: umami-mcp-server
Anforderungen
Node.js
>= 20pnpm
>= 10
Installation
Über npm:
npm install -g umami-analytics-mcpOder ohne Installation ausführen:
npx -y umami-analytics-mcpFür die lokale Entwicklung in diesem Repository:
pnpm installKonfiguration
Erstellen Sie eine .env-Datei basierend auf .env.example.
cp .env.example .envFüllen Sie eine der folgenden Authentifizierungsoptionen aus:
API-Schlüssel-Modus
UMAMI_API_URL=https://api.umami.is/v1
UMAMI_API_KEY=your-api-key
UMAMI_DEFAULT_TIMEZONE=Asia/ShanghaiModus für selbst gehosteten Benutzername/Passwort
UMAMI_API_URL=https://umami.example.com/api
UMAMI_USERNAME=admin
UMAMI_PASSWORD=secret
UMAMI_DEFAULT_TIMEZONE=Asia/ShanghaiHinweise:
UMAMI_API_URLsollte auf die API-Basis zeigen, nicht nur auf den Ursprung der Website.Wenn sowohl
UMAMI_API_KEYals auch Benutzername/Passwort festgelegt sind, hatUMAMI_API_KEYVorrang.UMAMI_DEFAULT_TIMEZONEwird verwendet, wenn ein Tool eine Zeitzone unterstützt und Sie diese weglassen.
Lokal ausführen
Entwicklungsmodus:
pnpm devErstellen und ausführen:
pnpm build
pnpm startDer Server verwendet den MCP-Stdio-Transport und bleibt daher mit stdin/stdout verbunden, bis der Client die Verbindung trennt.
Bei einer Installation über npm lautet der entsprechende Befehl:
umami-analytics-mcpTesten
pnpm test
pnpm buildEs gibt auch eine Vorlage für Integrationstests mit der echten API, die standardmäßig übersprungen wird:
UMAMI_INTEGRATION_TEST=1 pnpm test:integrationMCP-Inspektor
Zuerst erstellen:
pnpm buildStarten Sie dann den offiziellen MCP-Inspektor für den erstellten Server:
npx @modelcontextprotocol/inspector node dist/cli.jsFür Hot-Reload während der Entwicklung funktioniert auch:
npx @modelcontextprotocol/inspector pnpm devWenn Sie stattdessen den Pfad des veröffentlichten Pakets testen möchten, verwenden Sie:
npx @modelcontextprotocol/inspector npx -y umami-analytics-mcpStellen Sie sicher, dass dem Inspektor-Prozess dieselben Umami-Umgebungsvariablen zur Verfügung stehen.
Empfohlene Smoke-Tests im Inspektor:
umami_pingumami_list_websitesumami_get_statsumami_get_breakdown
Tools
umami_ping
Überprüft die Konfiguration und Authentifizierung.
Beispiel:
{}umami_list_websites
Listet zugängliche Websites auf.
Beispiel:
{}umami_find_website
Fuzzy-Suche nach Website-Name oder Domain.
Beispiel:
{
"query": "example.com"
}umami_get_stats
Zusammenfassende Statistiken für eine Website und einen Zeitraum.
Beispiel:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab",
"startAt": "2026-04-23T00:00:00+08:00",
"endAt": "2026-04-23T23:59:59+08:00",
"filters": {
"path": "/pricing"
}
}umami_get_pageviews
Zeitreihen für Seitenaufrufe und Sitzungen.
Beispiel:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab",
"startAt": "2026-04-17T00:00:00+08:00",
"endAt": "2026-04-23T23:59:59+08:00",
"unit": "day",
"compare": "prev",
"filters": {
"path": "/blog"
}
}umami_get_breakdown
Aufschlüsselungszeilen wie Top-Seiten, Referrer, Länder, Browser, Geräte und mehr.
Beispiel:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab",
"startAt": "2026-04-17T00:00:00+08:00",
"endAt": "2026-04-23T23:59:59+08:00",
"type": "path",
"limit": 10,
"expanded": false
}umami_get_active
Gibt die aktuelle Anzahl der aktiven Besucher zurück.
Beispiel:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab"
}umami_get_events_series
Gibt benutzerdefinierte Ereignisanzahlen im Zeitverlauf zurück.
Beispiel:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab",
"startAt": "2026-04-17T00:00:00+08:00",
"endAt": "2026-04-23T23:59:59+08:00",
"unit": "day"
}Gemeinsame Filter
Diese Tools unterstützen dasselbe filters-Objekt:
pathreferrertitlequerybrowserosdevicecountryregioncityhostname
Fehlerbehandlung
Tool-Fehler werden als strukturierte MCP-Tool-Ergebnisse mit folgenden Kategorien zurückgegeben:
config_missingauth_failedwebsite_not_foundumami_http_errornetwork_timeoutnetwork_errorinvalid_input
In jedem Stdio-MCP-Client einbinden
Jeder stdio-basierte MCP-Client kann diesen Server wie folgt ausführen:
command:npxargs:["-y", "umami-analytics-mcp"]env: Ihre Umami-Variablen
Beispiel-JSON-Snippet für Clients, die ein mcpServers-Objekt verwenden:
{
"mcpServers": {
"umami": {
"command": "npx",
"args": ["-y", "umami-analytics-mcp"],
"env": {
"UMAMI_API_URL": "https://umami.example.com/api",
"UMAMI_USERNAME": "admin",
"UMAMI_PASSWORD": "secret",
"UMAMI_DEFAULT_TIMEZONE": "Asia/Shanghai"
}
}
}
}Für einen lokalen, nicht veröffentlichten Checkout können Sie weiterhin direkt auf die erstellte Datei verweisen:
{
"mcpServers": {
"umami": {
"command": "node",
"args": ["/absolute/path/to/umami-mcp/dist/cli.js"]
}
}
}Auf npm veröffentlichen
Dieses Repository ist jetzt als npm-CLI-Paket strukturiert.
Empfohlener Release-Ablauf:
pnpm test
pnpm build
pnpm pack --dry-run
npm login
pnpm publishHinweise:
Der Paketname ist auf
umami-analytics-mcpfestgelegt, daumami-mcpauf npm bereits vergeben ist.Die aktuelle
licenseistUNLICENSEDals sicherer Platzhalter. Ersetzen Sie diese vor einer echten öffentlichen Open-Source-Veröffentlichung, wenn Sie eine permissive Lizenz wünschen.Wenn Sie später unter Ihrem eigenen npm-Scope veröffentlichen, ändern Sie nur das Feld
namein derpackage.json.
Interne Dokumentation
API-Zusammenfassung, die von diesem Repository verwendet wird: docs/umami-api.md
Available Tools
8 toolsumami_find_websiteFind Umami WebsiteARead-only
Search Umami websites by name or domain using fuzzy matching. Useful before calling other analytics tools.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Website name or domain fragment to search for. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds fuzzy matching behavior beyond the readOnlyHint annotation. However, it does not mention the return format or if there are limits, but for a simple search it is sufficient.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single concise sentence with a clear usage hint, no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the simple tool with one parameter, readOnly annotation, and no output schema, the description provides all essential information: purpose, usage context, and parameter meaning.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the query parameter is already well described in the schema. The description adds minimal extra meaning beyond 'search by name or domain'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool searches for Umami websites by name or domain using fuzzy matching, and the title confirms 'Find Umami Website'. It is distinct from siblings which are get/list operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly says 'Useful before calling other analytics tools,' providing clear context for when to use this tool versus the other tools available.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_get_activeGet Umami Active VisitorsARead-only
Get the number of active visitors on a website during the last 5 minutes.
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Umami website ID. Use umami_list_websites or umami_find_website first if you do not know it. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, so the description carries less burden. It adds the specific time window ('last 5 minutes'), which is a useful behavioral detail beyond the annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single, concise sentence that contains no filler or redundant information. Every word adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only tool with one parameter and no output schema, the description is fairly complete. It specifies the metric and time window, and the parameter description provides guidance on how to find the websiteId. However, it does not explicitly state the return type (e.g., integer).
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 100% description coverage, so the baseline is 3. The tool description adds no additional meaning about the parameter; the parameter's own description already explains how to obtain the websiteId.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the specific verb (Get), resource (active visitors), and scope (last 5 minutes), distinguishing it from siblings like umami_get_pageviews or umami_get_stats.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not provide any guidance on when to use this tool versus alternatives, nor does it mention when not to use it. The parameter description hints at prerequisites but the main description lacks usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_get_breakdownGet Umami BreakdownARead-only
Get a metric breakdown for a website and time range. Use expanded=true for detailed metrics or expanded=false for x/y breakdown rows.
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Umami website ID. Use umami_list_websites or umami_find_website first if you do not know it. | |
| startAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| endAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| type | Yes | Breakdown dimension. Supported values: path, entry, exit, title, query, referrer, channel, domain, country, region, city, browser, os, device, language, screen, event, hostname, tag, distinctId. | |
| limit | No | Maximum number of rows to return. Umami defaults to 500 when omitted. | |
| offset | No | Number of rows to skip. Defaults to 0 when omitted. | |
| expanded | No | Set to true to call /metrics/expanded instead of /metrics. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare 'readOnlyHint: true', so the description does not need to restate that. The description adds some behavioral context about the two modes (detailed vs x/y breakdown rows), but it does not disclose other behavioral traits like rate limits, data freshness, or pagination behavior that might be relevant. No contradictions 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.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise at two sentences, with the purpose front-loaded. Every sentence adds value: the first states the core functionality, and the second provides key usage guidance on the 'expanded' parameter. No unnecessary words or repetition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (8 parameters, nested filters, enum for 'type') and the absence of an output schema, the description is fairly complete. It covers the main purpose and the critical 'expanded' parameter. However, it could be more complete by briefly noting that other parameters (like 'type' and 'filters') are documented in the schema, but the description relies on the schema for those details, which is acceptable.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds value beyond the schema by explaining the distinction between 'expanded=true' and 'expanded=false' (detailed metrics vs x/y breakdown rows). This clarifies the parameter's effect on the output format, which is not fully covered in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Get a metric breakdown for a website and time range.' It specifies the resource (metric breakdown), action (get), and scope (website and time range). It also distinguishes between two modes ('expanded=true' vs 'expanded=false'), which differentiates it from siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides guidance on when to use the 'expanded' parameter, but it does not explicitly state when to use this tool versus alternative tools like 'umami_get_stats' or 'umami_get_pageviews'. It lacks exclusions or alternative recommendations, making the usage context clear but incomplete.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_get_events_seriesGet Umami Events SeriesBRead-only
Get custom event counts for a website over time. Returns event name, timestamp, and count rows.
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Umami website ID. Use umami_list_websites or umami_find_website first if you do not know it. | |
| startAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| endAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| unit | Yes | Time bucket unit. Allowed values: hour, day, month, year. | |
| timezone | No | IANA timezone, for example Asia/Shanghai. Defaults to UMAMI_DEFAULT_TIMEZONE when omitted. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true, so the safety profile is clear. The description adds that it returns rows with event name, timestamp, and count, but does not disclose any additional behavioral traits beyond what annotations provide.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two concise sentences with no wasted words. It is efficiently structured, though it could benefit from slightly more detail on output structure.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the absence of an output schema, the description partially explains the return values (event name, timestamp, count rows) but lacks detail on the exact data structure (e.g., whether it's an array, how fields are named). For a tool with moderate complexity, this is somewhat incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with detailed parameter descriptions (e.g., websiteId referencing other tools, startAt/endAt examples, unit enum). The description adds minimal extra semantic information, so it is adequate but not exceptional.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it gets custom event counts over time for a website, with a specific resource (custom events) that distinguishes it from sibling tools like umami_get_pageviews (pageviews) and umami_get_breakdown (breakdown data).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives like umami_get_pageviews or umami_get_stats. The description only explains what it does without contextualizing when it is the best choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_get_pageviewsGet Umami Pageviews SeriesARead-only
Get pageview and session time series for a website. Supports time bucketing, timezone, period comparison, and shared filters.
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Umami website ID. Use umami_list_websites or umami_find_website first if you do not know it. | |
| startAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| endAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| unit | Yes | Time bucket unit. Allowed values: hour, day, month, year. | |
| timezone | No | IANA timezone, for example Asia/Shanghai. Defaults to UMAMI_DEFAULT_TIMEZONE when omitted. | |
| compare | No | Optional comparison mode. Use prev for previous period or yoy for year-over-year. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true, and the description aligns with a read operation. It adds useful context about the type of data returned (time series) and supported features. No behavioral traits are contradicted, and the description provides additional value beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the main purpose. Every sentence adds value without redundancy. Highly efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool has 7 parameters (4 required) and no output schema, the description covers the main features. However, it does not mention the output format, which would be helpful since no output schema is provided. Still, it is mostly complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so baseline is 3. The description mentions time bucketing, timezone, comparison, and filters, which corresponds to parameters, but does not add new meaning beyond what the schema already provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states it retrieves 'pageview and session time series', using a specific verb and resource. It lists supported features (time bucketing, timezone, etc.), distinguishing it from sibling tools like umami_get_stats (aggregates) or umami_get_breakdown (dimension breakdown).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description does not explicitly state when to use this tool versus alternatives. While it lists features, it lacks guidance on when not to use it or which sibling to choose instead, leaving the agent to infer from context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_get_statsGet Umami StatsARead-only
Get summarized Umami stats for a website and time range. Returns pageviews, visitors, visits, bounces, totaltime, and comparison data.
| Name | Required | Description | Default |
|---|---|---|---|
| websiteId | Yes | Umami website ID. Use umami_list_websites or umami_find_website first if you do not know it. | |
| startAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| endAt | Yes | An ISO 8601 datetime string or a millisecond timestamp. Example: 2026-04-23T00:00:00+08:00 or 1776873600000. | |
| filters | No | Optional filter object shared by Umami analytics endpoints. |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint annotation already indicates the tool is read-only. The description adds no additional behavioral context (e.g., authentication, rate limits, error handling) beyond stating the action, which is consistent with the annotation.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description consists of two short sentences that front-load the main purpose and list return values. Every word is necessary and informative, with no redundancy or extraneous details.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has no output schema, so the description's list of return metrics provides essential context. Combined with the rich input schema descriptions and readOnlyHint, it is largely complete. Minor gap: no indication of the response structure or aggregation details, but it suffices for agent invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% with detailed parameter descriptions (e.g., examples for dates, explanations for websiteId). The tool description adds no extra parameter semantics; its mention of returned metrics pertains to output, not input parameters. Baseline 3 applies per guidelines.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb 'Get summarized Umami stats' and specifies the resource 'a website and time range', along with listing the returned metrics (pageviews, visitors, visits, bounces, totaltime, comparison data). This effectively distinguishes it from sibling tools like umami_get_pageviews or umami_get_breakdown.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is for obtaining aggregate stats over a period, but it does not explicitly state when to prefer this tool over alternatives, nor does it mention when not to use it. No comparison or exclusion criteria are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_list_websitesList Umami WebsitesARead-only
List accessible Umami websites. Returns id, name, domain, and createdAt for each website.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true; the description adds value by specifying return fields (id, name, domain, createdAt) but does not disclose additional behaviors like pagination or rate limits.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences front-loaded with the action and result, no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Complete for a simple list operation given no parameters, readOnlyHint annotation, and no output schema; could mention if the list includes all websites or is paginated.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With 0 parameters, baseline is 4. The description adds meaning by detailing the returned fields, surpassing the schema's minimal coverage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb 'List' and clearly identifies the resource 'Umami websites', distinguishing it from sibling tools like 'umami_find_website' which implies searching.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives such as 'umami_find_website' for searching specific websites.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
umami_pingUmami PingARead-only
Validate Umami configuration and authentication. Returns the auth mode, API base URL, instance URL, default timezone, and current user info.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=true, and the description confirms it is a read operation by specifying what it returns. It adds operational context about the return values beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, focused sentence that efficiently conveys the tool's purpose and return values with no wasted words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no parameters, no output schema, and the simple nature of the tool (validation), the description fully covers what an agent needs to know: what it does and what it returns.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
There are no parameters, so the baseline is 4. The description correctly provides no parameter information as none are needed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool validates Umami configuration and authentication, listing specific return fields (auth mode, API base URL, instance URL, default timezone, current user info). This distinguishes it from sibling tools that retrieve analytics data.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage after configuration to check connectivity, but does not explicitly state when not to use it or suggest alternatives. It is clear enough for basic guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
8 tool updates
v0.1.0- First observed
umami_find_website - First observed
umami_get_active - First observed
umami_get_breakdown - First observed
umami_get_events_series - First observed
umami_get_pageviews - First observed
umami_get_stats - First observed
umami_list_websites - First observed
umami_ping
TDQS
Scored across 8 tools
Each tool serves a distinct purpose: searching, listing, validating, and retrieving various analytics metrics (active visitors, breakdown, events, pageviews, stats). No overlap or ambiguity.
All tool names follow a consistent 'umami_verb_noun' pattern (e.g., umami_find_website, umami_get_active). The pattern is uniform and predictable.
With 8 tools, the set is well-scoped for an analytics API. It covers essential query operations without being bloated or sparse.
The tool set provides comprehensive read-only access to Umami analytics: website listing/search, active visitors, pageviews, events, breakdowns, stats, and authentication validation. No obvious gaps for querying use cases.
Maintenance
Related MCP Connectors
Hosted MCP server for GA4, Google Ads and Search Console. Google OAuth, nothing to install.
MCP server for querying and analyzing data from ad platforms, analytics tools, and spreadsheets
MCP server for the Seline Analytics API
Related MCP Servers
- AlicenseCqualityBmaintenanceMCP server exposing Umami analytics (Cloud + self-hosted)5MIT
- AlicenseNot gradedqualityCmaintenanceMCP server for Umami Analytics that provides read-only tools to query website stats, events, sessions, reports, and more, enabling natural language analytics queries.14 npm3MIT
- AlicenseAqualityDmaintenanceA security-first MCP server for Umami analytics (Cloud and self-hosted v3) enabling analytics, reporting, and administration with least privilege and credential-safe design.3225 npmMIT
- AlicenseAqualityDmaintenanceA read-only MCP server for Umami analytics, enabling natural language queries of website stats, traffic trends, events, sessions, and analytics reports.1314 npm1Elastic 2.0