Umami MCP Server
Umami MCP 서버
Umami 분석을 위한 읽기 전용 MCP 서버입니다. HTTP를 통해 Umami REST API와 직접 통신하며, 자체 호스팅 Umami를 우선 지원하고 Umami Cloud API 키와도 작동합니다.
이 저장소는 상위 계층 에이전트가 매번 Umami 문서를 다시 읽지 않고도 분석 데이터를 요청할 수 있도록 구축되었습니다. 브라우저 자동화, DOM 스크래핑, 쓰기 작업은 포함하지 않습니다.
기능
가장 일반적인 Umami 분석 쿼리를 위한 읽기 전용 MCP 도구
두 가지 인증 모드:
UMAMI_API_KEYUMAMI_USERNAME+UMAMI_PASSWORD
메모리 내 자체 호스팅 베어러 토큰 캐싱
사용자 이름/비밀번호 모드에서
401발생 시 자동 재로그인 및 1회 재시도ISO 시간 문자열 및 밀리초 타임스탬프 모두 허용
통계, 페이지뷰, 분석(breakdown), 이벤트 시리즈 전반에 걸친 공유 필터 처리
작고 유지 관리가 쉬운 모듈로 구성된 엄격한 TypeScript
명확한 구조화된 도구 출력 및 명시적 오류 범주
Related MCP server: umami-mcp-server
요구 사항
Node.js
>= 20pnpm
>= 10
설치
npm 사용:
npm install -g umami-analytics-mcp또는 설치 없이 실행:
npx -y umami-analytics-mcp이 저장소에서 로컬 개발을 하려면:
pnpm install구성
.env.example에서 .env 파일을 생성합니다.
cp .env.example .env다음 인증 옵션 중 하나를 입력합니다:
API 키 모드
UMAMI_API_URL=https://api.umami.is/v1
UMAMI_API_KEY=your-api-key
UMAMI_DEFAULT_TIMEZONE=Asia/Shanghai자체 호스팅 사용자 이름/비밀번호 모드
UMAMI_API_URL=https://umami.example.com/api
UMAMI_USERNAME=admin
UMAMI_PASSWORD=secret
UMAMI_DEFAULT_TIMEZONE=Asia/Shanghai참고:
UMAMI_API_URL은 사이트 오리진뿐만 아니라 API 베이스를 가리켜야 합니다.UMAMI_API_KEY와 사용자 이름/비밀번호가 모두 설정된 경우UMAMI_API_KEY가 우선합니다.UMAMI_DEFAULT_TIMEZONE은 도구가 시간대를 지원하고 사용자가 이를 생략할 때 사용됩니다.
로컬 실행
개발 모드:
pnpm dev빌드 및 실행:
pnpm build
pnpm start서버는 MCP stdio 전송을 사용하므로 클라이언트가 연결을 끊을 때까지 stdin/stdout에 연결된 상태로 유지됩니다.
npm에서 설치한 경우, 동일한 명령은 다음과 같습니다:
umami-analytics-mcp테스트
pnpm test
pnpm build기본적으로 건너뛰는 실제 API 통합 테스트 템플릿도 있습니다:
UMAMI_INTEGRATION_TEST=1 pnpm test:integrationMCP 인스펙터
먼저 빌드:
pnpm build그런 다음 빌드된 서버에 대해 공식 MCP 인스펙터를 실행합니다:
npx @modelcontextprotocol/inspector node dist/cli.js개발 중 핫 리로드를 원하면 다음도 작동합니다:
npx @modelcontextprotocol/inspector pnpm dev게시된 패키지 경로를 테스트하려면 다음을 사용하세요:
npx @modelcontextprotocol/inspector npx -y umami-analytics-mcp인스펙터 프로세스에서 동일한 Umami 환경 변수를 사용할 수 있는지 확인하세요.
인스펙터에서 권장되는 스모크 테스트 호출:
umami_pingumami_list_websitesumami_get_statsumami_get_breakdown
도구
umami_ping
구성 및 인증을 검증합니다.
예시:
{}umami_list_websites
액세스 가능한 웹사이트를 나열합니다.
예시:
{}umami_find_website
웹사이트 이름이나 도메인으로 퍼지 검색을 수행합니다.
예시:
{
"query": "example.com"
}umami_get_stats
웹사이트 및 시간 범위에 대한 요약 통계를 제공합니다.
예시:
{
"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
시계열 페이지뷰 및 세션 데이터를 제공합니다.
예시:
{
"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
인기 페이지, 리퍼러, 국가, 브라우저, 기기 등과 같은 분석 행을 제공합니다.
예시:
{
"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
현재 활성 방문자 수를 반환합니다.
예시:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab"
}umami_get_events_series
시간에 따른 사용자 지정 이벤트 수를 반환합니다.
예시:
{
"websiteId": "8f2f8ce2-1234-4567-89ab-0123456789ab",
"startAt": "2026-04-17T00:00:00+08:00",
"endAt": "2026-04-23T23:59:59+08:00",
"unit": "day"
}공유 필터
이 도구들은 동일한 filters 객체를 지원합니다:
pathreferrertitlequerybrowserosdevicecountryregioncityhostname
오류 처리
도구 오류는 다음 범주를 포함하는 구조화된 MCP 도구 결과로 반환됩니다:
config_missingauth_failedwebsite_not_foundumami_http_errornetwork_timeoutnetwork_errorinvalid_input
모든 Stdio MCP 클라이언트에 마운트
모든 stdio 기반 MCP 클라이언트는 다음을 사용하여 이 서버를 실행할 수 있습니다:
command:npxargs:["-y", "umami-analytics-mcp"]env: 사용자의 Umami 변수
mcpServers 객체를 사용하는 클라이언트를 위한 예시 JSON 스니펫:
{
"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"
}
}
}
}로컬 미출시 체크아웃의 경우, 빌드된 파일을 직접 가리킬 수 있습니다:
{
"mcpServers": {
"umami": {
"command": "node",
"args": ["/absolute/path/to/umami-mcp/dist/cli.js"]
}
}
}npm에 게시
이 저장소는 이제 npm CLI 패키지로 구조화되어 있습니다.
권장 릴리스 흐름:
pnpm test
pnpm build
pnpm pack --dry-run
npm login
pnpm publish참고:
umami-mcp가 이미 npm에 등록되어 있으므로 패키지 이름은umami-analytics-mcp로 설정되었습니다.현재
license는 안전한 자리 표시자로UNLICENSED로 설정되어 있습니다. 허용적인 라이선스를 원하시면 실제 공개 오픈 소스 릴리스 전에 교체하세요.나중에 자신의 npm 스코프 하에 게시하려면
package.json의name필드만 변경하세요.
내부 문서
이 저장소에서 사용하는 API 요약: 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