Skip to content
VS Code

Umami Compass for VS Code

io.github.webcredo/umami-compass

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

client:VS Code transport:stdio runtime:npm

Install Umami Compass in VS Code

.vscode/mcp.json

{
  "inputs": [
    {
      "type": "promptString",
      "id": "umami-api-key",
      "description": "UMAMI_API_KEY",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-access-token",
      "description": "UMAMI_ACCESS_TOKEN",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-username",
      "description": "UMAMI_USERNAME",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-password",
      "description": "UMAMI_PASSWORD",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-url",
      "description": "UMAMI_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-api-url",
      "description": "UMAMI_API_URL",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-website-ids",
      "description": "UMAMI_WEBSITE_IDS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-team-ids",
      "description": "UMAMI_TEAM_IDS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-toolsets",
      "description": "UMAMI_TOOLSETS",
      "password": true
    },
    {
      "type": "promptString",
      "id": "umami-max-response-bytes",
      "description": "UMAMI_MAX_RESPONSE_BYTES",
      "password": true
    }
  ],
  "servers": {
    "umami-compass": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "umami-compass"
      ],
      "env": {
        "UMAMI_API_KEY": "${input:umami-api-key}",
        "UMAMI_ACCESS_TOKEN": "${input:umami-access-token}",
        "UMAMI_USERNAME": "${input:umami-username}",
        "UMAMI_PASSWORD": "${input:umami-password}",
        "UMAMI_URL": "${input:umami-url}",
        "UMAMI_API_URL": "${input:umami-api-url}",
        "UMAMI_WEBSITE_IDS": "${input:umami-website-ids}",
        "UMAMI_TEAM_IDS": "${input:umami-team-ids}",
        "UMAMI_TOOLSETS": "${input:umami-toolsets}",
        "UMAMI_MAX_RESPONSE_BYTES": "${input:umami-max-response-bytes}"
      }
    }
  }
}

VS Code prompts for each input the first time the server starts, so no secret is written to the file. VS Code docs

Umami Compass in other clients