Umami Compass MCP Server

by webcredoio.github.webcredo/umami-compassv0.5.1

Secure Umami Analytics MCP server for Cloud and self-hosted deployments

0Node.jsstdioofficial registry

context tax

queued

security

queued

cold start

queued

freshness

Active23d ago

Install Umami Compass MCP server

claude mcp add umami-compass -e UMAMI_API_KEY='<umami-api-key>' -e UMAMI_ACCESS_TOKEN='<umami-access-token>' -e UMAMI_PASSWORD='<umami-password>' -- npx -y umami-compass

{
  "mcpServers": {
    "umami-compass": {
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<umami-api-key>",
        "UMAMI_ACCESS_TOKEN": "<umami-access-token>",
        "UMAMI_PASSWORD": "<umami-password>"
      }
    }
  }
}

Add to ~/.cursor/mcp.json (global) or .cursor/mcp.json (project).

{
  "mcpServers": {
    "umami-compass": {
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<umami-api-key>",
        "UMAMI_ACCESS_TOKEN": "<umami-access-token>",
        "UMAMI_PASSWORD": "<umami-password>"
      }
    }
  }
}

Settings → Developer → Edit Config (claude_desktop_config.json), then restart.

{
  "servers": {
    "umami-compass": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<umami-api-key>",
        "UMAMI_ACCESS_TOKEN": "<umami-access-token>",
        "UMAMI_PASSWORD": "<umami-password>"
      }
    }
  }
}

Add to .vscode/mcp.json in your workspace.

{
  "mcpServers": {
    "umami-compass": {
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<umami-api-key>",
        "UMAMI_ACCESS_TOKEN": "<umami-access-token>",
        "UMAMI_PASSWORD": "<umami-password>"
      }
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json.

Configuration

Variable	Required	Secret	Description
UMAMI_API_KEY	—	yes	Umami Cloud or client API key
UMAMI_ACCESS_TOKEN	—	yes	Existing self-hosted Bearer token
UMAMI_USERNAME	—	—	Self-hosted Umami username
UMAMI_PASSWORD	—	yes	Self-hosted Umami password
UMAMI_URL	—	—	Self-hosted Umami instance origin
UMAMI_API_URL	—	—	Optional exact Umami API root for a reverse proxy
UMAMI_WEBSITE_IDS	—	—	Optional comma-separated website UUID allowlist
UMAMI_TEAM_IDS	—	—	Optional comma-separated team UUID allowlist
UMAMI_TOOLSETS	—	—	Comma-separated toolsets or all
UMAMI_MAX_RESPONSE_BYTES	—	—	Maximum decoded upstream JSON response size in bytes

Freshness

Active — last maintenance signal 23d ago. The newest of the signals below sets the band.

Last commit (default branch)
2026-09-17 · 23d ago · GitHub
Latest release
2026-07-21 · 3mo ago · GitHub · v0.5.1
Package published
no data · npm/PyPI
Registry entry updated
2026-07-21 · 3mo ago · official registry · v0.5.1

FAQ

›How do I install the Umami Compass MCP server in Claude Code?

Run: claude mcp add umami-compass -e UMAMI_API_KEY='<umami-api-key>' -e UMAMI_ACCESS_TOKEN='<umami-access-token>' -e UMAMI_PASSWORD='<umami-password>' -- npx -y umami-compass. For Cursor, VS Code, Claude Desktop and Windsurf, use the install tabs above.

›Does Umami Compass require an API key?

Yes. It expects UMAMI_API_KEY, UMAMI_ACCESS_TOKEN, UMAMI_PASSWORD, of which 3 are secrets.

›Can I use Umami Compass as a remote (hosted) MCP server?

No hosted endpoint is published; it runs locally over stdio.

›Is Umami Compass in the official MCP registry?

Yes, as io.github.webcredo/umami-compass.