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 分