Umami Compass MCP Server

Name: Umami Compass MCP Server
Author: io.github.webcredo

io.github.webcredo/umami-compass

Repository Registry

What is the Umami Compass MCP server?

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

How to install Umami Compass

Copy-paste configuration for popular MCP clients.

transport: stdio

Config generated by PluginBench — verify against the source before use.

Environment / auth

UMAMI_API_KEY
secret
Umami Cloud or client API key
UMAMI_ACCESS_TOKEN
secret
Existing self-hosted Bearer token
UMAMI_USERNAME
Self-hosted Umami username
UMAMI_PASSWORD
secret
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

Claude Desktop

~/Library/Application Support/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "umami-compass": {
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<YOUR_UMAMI_API_KEY>",
        "UMAMI_ACCESS_TOKEN": "<YOUR_UMAMI_ACCESS_TOKEN>",
        "UMAMI_USERNAME": "<YOUR_UMAMI_USERNAME>",
        "UMAMI_PASSWORD": "<YOUR_UMAMI_PASSWORD>",
        "UMAMI_URL": "<YOUR_UMAMI_URL>",
        "UMAMI_API_URL": "<YOUR_UMAMI_API_URL>",
        "UMAMI_WEBSITE_IDS": "<YOUR_UMAMI_WEBSITE_IDS>",
        "UMAMI_TEAM_IDS": "<YOUR_UMAMI_TEAM_IDS>",
        "UMAMI_TOOLSETS": "<YOUR_UMAMI_TOOLSETS>",
        "UMAMI_MAX_RESPONSE_BYTES": "<YOUR_UMAMI_MAX_RESPONSE_BYTES>"
      }
    }
  }
}

Cursor

~/.cursor/mcp.json

{
  "mcpServers": {
    "umami-compass": {
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<YOUR_UMAMI_API_KEY>",
        "UMAMI_ACCESS_TOKEN": "<YOUR_UMAMI_ACCESS_TOKEN>",
        "UMAMI_USERNAME": "<YOUR_UMAMI_USERNAME>",
        "UMAMI_PASSWORD": "<YOUR_UMAMI_PASSWORD>",
        "UMAMI_URL": "<YOUR_UMAMI_URL>",
        "UMAMI_API_URL": "<YOUR_UMAMI_API_URL>",
        "UMAMI_WEBSITE_IDS": "<YOUR_UMAMI_WEBSITE_IDS>",
        "UMAMI_TEAM_IDS": "<YOUR_UMAMI_TEAM_IDS>",
        "UMAMI_TOOLSETS": "<YOUR_UMAMI_TOOLSETS>",
        "UMAMI_MAX_RESPONSE_BYTES": "<YOUR_UMAMI_MAX_RESPONSE_BYTES>"
      }
    }
  }
}

Windsurf

~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "umami-compass": {
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<YOUR_UMAMI_API_KEY>",
        "UMAMI_ACCESS_TOKEN": "<YOUR_UMAMI_ACCESS_TOKEN>",
        "UMAMI_USERNAME": "<YOUR_UMAMI_USERNAME>",
        "UMAMI_PASSWORD": "<YOUR_UMAMI_PASSWORD>",
        "UMAMI_URL": "<YOUR_UMAMI_URL>",
        "UMAMI_API_URL": "<YOUR_UMAMI_API_URL>",
        "UMAMI_WEBSITE_IDS": "<YOUR_UMAMI_WEBSITE_IDS>",
        "UMAMI_TEAM_IDS": "<YOUR_UMAMI_TEAM_IDS>",
        "UMAMI_TOOLSETS": "<YOUR_UMAMI_TOOLSETS>",
        "UMAMI_MAX_RESPONSE_BYTES": "<YOUR_UMAMI_MAX_RESPONSE_BYTES>"
      }
    }
  }
}

VS Code

.vscode/mcp.json

{
  "servers": {
    "umami-compass": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "<YOUR_UMAMI_API_KEY>",
        "UMAMI_ACCESS_TOKEN": "<YOUR_UMAMI_ACCESS_TOKEN>",
        "UMAMI_USERNAME": "<YOUR_UMAMI_USERNAME>",
        "UMAMI_PASSWORD": "<YOUR_UMAMI_PASSWORD>",
        "UMAMI_URL": "<YOUR_UMAMI_URL>",
        "UMAMI_API_URL": "<YOUR_UMAMI_API_URL>",
        "UMAMI_WEBSITE_IDS": "<YOUR_UMAMI_WEBSITE_IDS>",
        "UMAMI_TEAM_IDS": "<YOUR_UMAMI_TEAM_IDS>",
        "UMAMI_TOOLSETS": "<YOUR_UMAMI_TOOLSETS>",
        "UMAMI_MAX_RESPONSE_BYTES": "<YOUR_UMAMI_MAX_RESPONSE_BYTES>"
      }
    }
  }
}

Claude Code

claude mcp add umami-compass --env UMAMI_API_KEY=<YOUR_UMAMI_API_KEY> --env UMAMI_ACCESS_TOKEN=<YOUR_UMAMI_ACCESS_TOKEN> --env UMAMI_USERNAME=<YOUR_UMAMI_USERNAME> --env UMAMI_PASSWORD=<YOUR_UMAMI_PASSWORD> --env UMAMI_URL=<YOUR_UMAMI_URL> --env UMAMI_API_URL=<YOUR_UMAMI_API_URL> --env UMAMI_WEBSITE_IDS=<YOUR_UMAMI_WEBSITE_IDS> --env UMAMI_TEAM_IDS=<YOUR_UMAMI_TEAM_IDS> --env UMAMI_TOOLSETS=<YOUR_UMAMI_TOOLSETS> --env UMAMI_MAX_RESPONSE_BYTES=<YOUR_UMAMI_MAX_RESPONSE_BYTES> -- npx -y umami-compass