Umami

An MCP server for Umami Analytics that works with Umami Cloud and self-hosted instances.

python

GitHub Stars

python

Language

3 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "lukasschmit-umami-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/lukasschmit/umami-mcp",
        "umami-mcp"
      ],
      "env": {
        "UMAMI_URL": "https://api.umami.is",
        "UMAMI_DEBUG": "1",
        "UMAMI_API_KEY": "your_api_key_here",
        "UMAMI_PASSWORD": "your_password",
        "UMAMI_USERNAME": "admin",
        "UMAMI_USER_AGENT": "umami-mcp/1.0",
        "UMAMI_CF_ACCESS_CLIENT_ID": "your_client_id",
        "UMAMI_CF_ACCESS_CLIENT_SECRET": "your_client_secret"
      }
    }
  }
}

You can run an Umami MCP Server that connects to Umami Cloud or self-hosted instances, exposing five analytics tools over the MCP protocol. It requires zero local dependencies beyond the MCP client, and you control it by pointing your MCP client to the provided runtime command.

How to use

Connect your MCP client to the Umami MCP Server and use the built-in tools to retrieve website lists, stats, time-series data, detailed metrics, and the number of active visitors. Use the tools by issuing commands through your MCP client; the server handles authentication with Umami and returns JSON results for each request.

How to install

Prerequisites: you need a working MCP client and the runtime needed to execute the MCP server. Install the MCP runtime with the following command:

curl -LsSf https://astral.sh/uv/install.sh | sh

Additional content

Configure and run the Umami MCP Server through the MCP client you use. The server is provided as a self-contained runtime you call via a standard command. You will supply authentication details for Umami Cloud or a self-hosted Umami instance, depending on your setup. Use the following example configurations as starting points in your MCP client settings to connect to the Umami MCP Server.

{
  "mcpServers": {
    "umami": {
      "command": "uvx",
      "args": ["--from", "git+https://github.com/lukasschmit/umami-mcp", "umami-mcp"],
      "env": {
        "UMAMI_URL": "https://api.umami.is",
        "UMAMI_API_KEY": "your_api_key_here"
      }
    }
  }
}

Notes on configuration and usage

If your self-hosted Umami is protected by access controls, include Cloudflare Access credentials as environment variables to ensure machine-to-machine authentication.

The server supports both cloud and self-hosted modes. When using Umami Cloud, provide UMAMI_API_KEY. For self-hosted deployments, provide UMAMI_USERNAME and UMAMI_PASSWORD. You can also specify a custom user agent and a debugging flag to log outbound URLs for troubleshooting.

Available tools

get_websites

List all tracked websites in your Umami account.

get_stats

Return summary statistics including pageviews, visitors, visits, bounces, and total time.

get_pageviews

Provide time-series pageviews or sessions data with units (minute/hour/day/month/year) and a specified timezone.

get_metrics

Provide breakdowns by type such as path, url, entry, exit, referrer, domain, title, and other dimensions (browser, os, device, country, etc.).

get_active

Return the number of currently active visitors in the last five minutes.

Built by

VeilStrat

AI signals for GTM teams