ObsidianCorps Umami Analytics

io.github.ObsidianCorpsPublished by GitHub account ObsidianCorpsv0.1.2Updated Oct 24, 2026

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

VerifiedSTDIODesktop onlyWeb Search & ScrapingData & Analytics

Overview

AI-generated overview

Read-only MCP server for Umami Cloud or self-hosted Umami v3 analytics, letting an assistant query traffic, events, sessions, revenue and reports.

What you can do
  • Check connection and discover or inspect websites
  • Aggregate KPIs, series and ranked dimensions, plus the current 30-minute realtime window
  • Browse sessions, session properties and replay metadata, and list replays or replay event streams
  • Browse events and query event stats, series, properties, values and pivots
  • Fetch revenue stats, charts, dimensions and sessions
  • Run and discover funnel, journey, goal, retention, attribution, UTM, revenue, performance, breakdown and heatmap reports; list segments, cohorts, boards, links and pixels
When to use it
Useful when you want an assistant to answer questions about your own Umami analytics — traffic comparisons, conversion and source analysis, revenue, or Web Vitals and performance investigations — without exporting data to another analytics service.
Requirements
Node.js 20 or newer, run locally via npx or from source. Exactly one authentication mode: UMAMI_API_KEY for Umami Cloud, or UMAMI_BASE_URL with UMAMI_TOKEN, or with UMAMI_USERNAME and UMAMI_PASSWORD, optionally plus UMAMI_TWO_FACTOR_SECRET. UMAMI_DEFAULT_WEBSITE_ID is optional. Network access to the Umami API; non-local plain HTTP URLs are rejected unless explicitly allowed.
Before you install
Requires analytics credentials: UMAMI_API_KEY, UMAMI_TOKEN, or a username and password, and optionally the two-factor setup seed UMAMI_TWO_FACTOR_SECRET, which removes separation between factors — use a dedicated least-privilege account. Read-only by default; write tools appear only with UMAMI_ENABLE_WRITE_TOOLS, and reset/delete tools additionally need UMAMI_ENABLE_DESTRUCTIVE_TOOLS plus an exact confirmation string. HTTP transport needs MCP_BEARER_TOKEN and host/origin allowlists.

Installation

In SourceWeft

  1. Open ObsidianCorps Umami Analytics in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

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.

Source: README.md at commit e4c7439

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.1.2LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts