ObsidianCorps Umami Analytics

io.github.ObsidianCorps由 GitHub 账号 ObsidianCorps 发布v0.1.2更新于 Oct 24, 2026

Umami v3 MCP for Cloud or self-hosted analytics, with read-only, privacy-conscious defaults.

概览

AI 生成的概览

面向 Umami Cloud 或自建 Umami v3 的只读 MCP 服务器,让助手查询流量、事件、会话、收入与报表数据。

可以做什么
  • 检查连接状态,发现并查看网站
  • 汇总 KPI、时间序列与排名维度,并查看最近 30 分钟的实时数据
  • 浏览会话、会话属性与回放元数据,列出回放或获取回放事件流
  • 浏览事件,并查询事件统计、序列、属性、取值与透视
  • 获取收入统计、图表、维度与会话
  • 运行并发现漏斗、路径、目标、留存、归因、UTM、收入、性能、细分与热力图报表;列出分群、群组、看板、追踪链接与像素
适用场景
适合让助手回答关于自有 Umami 分析数据的问题,例如流量对比、转化与来源分析、收入,或 Web Vitals 与性能排查,而无需把数据导出到其他分析服务。
运行要求
需要 Node.js 20 或更高版本,通过 npx 或源码在本地运行。需且仅需一种认证方式:Umami Cloud 用 UMAMI_API_KEY;自建实例用 UMAMI_BASE_URL 搭配 UMAMI_TOKEN,或搭配 UMAMI_USERNAME 与 UMAMI_PASSWORD,可选再加 UMAMI_TWO_FACTOR_SECRET。UMAMI_DEFAULT_WEBSITE_ID 为可选项。需能访问 Umami API;非本地的明文 HTTP 地址会被拒绝,除非显式允许。
安装前请注意
需要分析账号凭据:UMAMI_API_KEY、UMAMI_TOKEN,或用户名加密码,可选的双因素设置种子 UMAMI_TWO_FACTOR_SECRET 会使两个因素不再分离,建议使用专用的最小权限账号。默认只读;仅在设置 UMAMI_ENABLE_WRITE_TOOLS 后才出现写入工具,重置/删除工具还需 UMAMI_ENABLE_DESTRUCTIVE_TOOLS 及精确的确认字符串。使用 HTTP 传输时需配置 MCP_BEARER_TOKEN 以及主机与来源白名单。

安装

在 SourceWeft 中

  1. 打开 控制台中的 ObsidianCorps Umami Analytics,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

ObsidianCorps Umami MCP

Ask questions about your self-hosted Umami analytics without sending the data to another analytics SaaS.

A secure, model-friendly Model Context Protocol server for Umami Cloud and self-hosted Umami Analytics. It targets Umami v3.3.1 and the 2026-07-28 MCP protocol, while retaining compatibility with 2025-era MCP clients.

[Umami MCP answering three analytics questions]

Install

Requirements: Node.js 20 or newer and one configured authentication mode.

bash
npx -y @obsidiancorps/umami-mcp

Try asking:

  • “Compare website traffic with last month.”
  • “Which sources generated the most conversions?”
  • “Find pages with poor Web Vitals.”

Agent skill

This repository also includes the Umami Analytics skill. The MCP server provides access to Umami; the skill guides an agent through traffic comparisons, conversion analysis, revenue, and performance investigations using those tools. It follows the Agent Skills format.

For MCP Market's Import from GitHub, use the skill folder URL:

text
https://github.com/ObsidianCorps/umami-mcp/tree/main/skills/umami-analytics

The URL must point to the folder containing SKILL.md. For a public repository, select Public repo. The folder must be pushed to main before the marketplace can import it.

For manual installation, copy skills/umami-analytics into your agent's skills directory (for example, .claude/skills/umami-analytics in a project). Configure and authenticate the MCP server separately; importing the skill does not install the server or grant access to analytics.

Why this implementation

  • Current Umami v3 coverage: revenue APIs, session replay, heatmaps, event/session property pivots and typed series, segments, cohorts, boards, links, pixels, Web Vitals reports, and the established analytics APIs.
  • Compact model surface: 17 read tools organize the API around analytical workflows instead of advertising dozens of near-duplicate endpoint tools.
  • Model-friendly inputs: website names/domains resolve automatically, one accessible website is selected automatically, and date ranges accept presets or exact ISO/epoch timestamps.
  • Structured MCP results: every tool advertises an output schema and returns structuredContent plus readable JSON.
  • Safe defaults: mutations are absent by default; destructive tools need a second opt-in and an exact target-specific confirmation string.
  • Two modern transports: local stdio and stateless Streamable HTTP. Legacy HTTP+SSE is intentionally not carried forward.
  • Defense in depth: response byte limits, request timeouts, HTTPS enforcement, token refresh, DNS-rebinding protection, exact origin checks, and constant-time MCP bearer checks.
  • Cloud and self-hosted auth: Umami Cloud API keys, pre-issued self-hosted tokens, or lazy username/password login—including Umami v3.3+ two-factor verification—with a single refresh after 401.

Configure

From source

Requirements: Node.js 20 or newer.

bash
npm installnpm run buildUMAMI_API_KEY=your-key node dist/cli.js

Example MCP client configuration:

json
{  "mcpServers": {    "umami": {      "command": "npx",      "args": ["-y", "@obsidiancorps/umami-mcp"],      "env": {        "UMAMI_API_KEY": "your-key",        "UMAMI_DEFAULT_WEBSITE_ID": "optional-website-uuid"      }    }  }}

For a source checkout, replace the command with node and the arguments with the absolute path to dist/cli.js.

Authentication

Choose exactly one mode:

ModeVariablesAPI base
Umami CloudUMAMI_API_KEYDefaults to https://api.umami.is/v1
Self-hosted tokenUMAMI_BASE_URL, UMAMI_TOKEN/api is added to a root URL
Self-hosted loginUMAMI_BASE_URL, UMAMI_USERNAME, UMAMI_PASSWORD/api is added to a root URL
Self-hosted login+2FALogin variables plus UMAMI_TWO_FACTOR_SECRET/api is added to a root URL
One-off 2FA loginLogin variables plus a current six-digit UMAMI_TWO_FACTOR_CODE/api is added to a root URL

UMAMI_TWO_FACTOR_SECRET is the Base32 setup seed shown when enrolling an authenticator. The MCP generates a six-digit SHA-1 TOTP just-in-time and never logs or returns it. Because storing the password and TOTP seed together removes the separation between factors, use a dedicated least-privilege Umami account and protect its environment. A pre-issued UMAMI_TOKEN avoids retaining either credential.

UMAMI_TWO_FACTOR_CODE is only a one-off fallback; it expires quickly and is unsuitable for normal MCP startup. Configure only one two-factor variable.

Non-local plain HTTP Umami URLs are rejected. For an explicitly trusted private network only, set UMAMI_ALLOW_INSECURE_HTTP=true.

Tools

The default read-only set is:

ToolPurpose
umami_check_connectionVerify auth and inspect the current account
umami_list_websites, umami_get_websiteDiscover and inspect sites
umami_get_overview, umami_get_metricsAggregate KPIs, series, and ranked dimensions
umami_get_realtimeInspect the current 30-minute activity window
umami_list_sessions, umami_inspect_sessionBrowse sessions, activity, properties, and replay metadata
umami_query_session_dataQuery session properties, pivots, stats, weekly traffic, and typed series
umami_list_events, umami_query_event_dataBrowse events, comparison stats, series, properties, values, and pivots
umami_get_revenueFetch revenue stats, charts, dimensions, and sessions
umami_list_replaysList replays or retrieve a replay event stream
umami_run_report, umami_list_reportsRun or discover funnel, journey, goal, retention, attribution, UTM, revenue, performance, breakdown, and heatmap reports
umami_list_segmentsDiscover segments and cohorts
umami_list_assetsDiscover boards, tracked links, and pixels

Resources expose umami://capabilities and the live umami://websites list. Reusable prompts cover analytics review, conversion review, and realtime triage.

Time ranges

Most analytical tools accept either:

  • period: last_24_hours, last_7_days, last_30_days, last_90_days, today, yesterday, this_week, last_week, this_month, or last_month; or
  • both startAt and endAt as epoch milliseconds or ISO 8601 timestamps with an offset.

Calendar periods honor the supplied IANA timezone. Rolling periods retain the most recent data instead of rounding to midnight.

Mutations and destructive operations

No mutation tool is registered by default.

bash
UMAMI_ENABLE_WRITE_TOOLS=true

This adds tools for creating/updating websites, segments, reports, boards/links/pixels, and sending analytics events. To additionally expose permanent reset/delete operations:

bash
UMAMI_ENABLE_WRITE_TOOLS=trueUMAMI_ENABLE_DESTRUCTIVE_TOOLS=true

Destructive calls require confirmation strings such as RESET <website-id> or DELETE reports <report-id>. MCP annotations also identify these tools as destructive so supporting hosts can require approval.

Streamable HTTP

Loopback example:

bash
MCP_TRANSPORT=http MCP_BEARER_TOKEN=replace-me npm start# MCP:    http://127.0.0.1:3000/mcp# Health: http://127.0.0.1:3000/health

For a container or non-loopback bind, both MCP_BEARER_TOKEN and MCP_ALLOWED_HOSTS are required:

bash
docker build -t umami-mcp .docker run --rm -p 3000:3000 \  -e UMAMI_API_KEY=your-key \  -e MCP_BEARER_TOKEN=long-random-secret \  -e MCP_ALLOWED_HOSTS=mcp.example.com \  umami-mcp

Set MCP_ALLOWED_ORIGINS to a comma-separated list of exact browser origins if browser-based MCP clients connect. Requests without an Origin header remain valid for native clients. Terminate TLS at a trusted reverse proxy; the built-in static bearer gate is suitable behind that boundary, not a replacement for OAuth on a public multi-user service.

Configuration reference

VariableDefaultDescription
UMAMI_BASE_URLCloud API for API-key authUmami root or full API base URL
UMAMI_DEFAULT_WEBSITE_ID—Avoids site resolution for most calls
UMAMI_TIMEOUT_MS15000Upstream request timeout, 100–120000 ms
UMAMI_MAX_RESPONSE_BYTES512000Maximum upstream response, 1 KB–10 MB
UMAMI_ENABLE_WRITE_TOOLSfalseRegisters non-destructive mutation tools
UMAMI_ENABLE_DESTRUCTIVE_TOOLSfalseRegisters reset/delete tools; requires write tools
MCP_TRANSPORTstdiostdio, http, or streamable-http
MCP_HOST127.0.0.1HTTP bind address
MCP_PORT3000HTTP port
MCP_BEARER_TOKEN—Protects the HTTP MCP endpoint
MCP_ALLOWED_HOSTS—Comma-separated hostnames for non-loopback HTTP
MCP_ALLOWED_ORIGINS—Comma-separated exact browser origins

Development

bash
npm installnpm testnpm run typechecknpm run lintnpm run format:checknpm run buildnpm run check

Tests drive the server through real in-memory, stdio, and Streamable HTTP MCP clients. See CONTRIBUTING.md and SECURITY.md before opening a change.

Compatibility baseline

  • Umami: v3.3.1, with compatibility expected for late v3 releases exposing the documented routes.
  • MCP SDK: TypeScript SDK v2.0.0.
  • MCP protocol: 2026-07-28 plus the SDK's stateless compatibility path for 2025-era clients.
  • Node.js: 20, 22, and 24.

Umami is a trademark of its respective owner. This independent integration is not affiliated with or endorsed by Umami Software.

License

Apache-2.0. See LICENSE.

来源:README.md,提交 e4c7439

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.1.2最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分