llms.txt

# umami-mcp

> Full-coverage MCP server for Umami Analytics API v2 — websites CRUD, stats, sessions, events, reports, user/team management, realtime monitoring from AI assistants

## Install

```json
{
  "mcpServers": {
    "umami": {
      "command": "npx",
      "args": ["-y", "@mikusnuz/umami-mcp"],
      "env": {
        "UMAMI_URL": "https://analytics.example.com",
        "UMAMI_USERNAME": "admin",
        "UMAMI_PASSWORD": "your-password"
      }
    }
  }
}
```

For Umami Cloud, replace `UMAMI_USERNAME`/`UMAMI_PASSWORD` with:
```
"UMAMI_API_KEY": "your-api-key"
```

## Tools (66 total)

### Websites (9)
- list_websites — List all tracked websites
- get_website — Get website details by ID
- create_website — Create a new website
- update_website — Update website configuration
- delete_website — Delete a website
- get_active_visitors — Get current active visitor count
- reset_website — Reset all analytics data for a website
- transfer_website — Transfer website ownership to another user
- get_website_reports — Get all reports for a website

### Stats & Analytics (9)
- get_stats — Summary statistics (pageviews, visitors, bounce rate, etc.)
- get_pageviews — Pageview/session counts over time
- get_metrics — Aggregated metrics (top pages, browsers, countries, etc.)
- get_events — Event data over time
- get_sessions — Session listing with filters
- get_daterange — Available data date range
- get_event_series — Event metrics over time (event series)
- get_session_stats — Summarized session statistics
- get_sessions_weekly — Weekly session data

### Sessions (5)
- get_session — Session details
- get_session_activity — Session activity log
- get_session_properties — Session custom properties
- get_session_data_properties — Session data property names and types
- get_session_data_values — Session data aggregated values

### Events (7)
- send_event — Send custom events/pageviews (server-side tracking)
- get_event_values — Event/session property values
- get_event_data_events — Event data events (custom event names and counts)
- get_event_data_fields — Event data fields (property keys and types)
- get_event_data_values — Event data values (aggregated counts for a property)
- get_event_data_stats — Event data statistics summary
- batch_events — Send multiple events in a single batch request

### Reports (6)
- list_reports — List saved reports
- get_report — Get report details
- create_report — Create and save a report
- update_report — Update an existing report
- delete_report — Delete a saved report
- run_report — Execute a report (funnel, retention, utm, goals, insights, revenue, journey, attribution)

### Users (8, admin only)
- list_users — List all users
- create_user — Create a new user (username, password, role)
- get_user — Get user details
- update_user — Update user (username, password, or role)
- delete_user — Delete a user
- get_user_websites — List websites a user has access to
- get_user_usage — Get usage statistics for a user
- get_user_teams — List teams a user belongs to

### Teams (14)
- list_teams — List all teams
- create_team — Create a new team
- get_team — Get team details
- update_team — Update team name
- delete_team — Delete a team
- join_team — Join a team using an access code
- list_team_users — List team members
- get_team_user — Get details of a specific team member
- add_team_user — Add a user to a team
- update_team_user — Update a team member's role
- remove_team_user — Remove a user from a team
- list_team_websites — List websites belonging to a team
- add_team_website — Add a website to a team
- remove_team_website — Remove a website from a team

### Account (7)
- get_me — Get current authenticated user profile
- get_my_websites — List current user's websites
- get_my_teams — List current user's teams
- update_my_password — Update current user's password
- verify_auth — Verify authentication token is valid
- get_share — Get shared website data by share ID
- heartbeat — Check if Umami server is healthy

### Realtime (1)
- get_realtime — Real-time data for last 30 minutes (visitors, URLs, referrers, countries, events)

### Prompts (2)
- site_overview — Comprehensive site analysis (stats + pageviews + top metrics + active visitors)
- traffic_compare — Compare traffic between two date ranges

### Resources (2)
- umami://websites — All tracked websites
- umami://me — Current user info

## Environment Variables

| Variable | Required | Description |
|----------|----------|-------------|
| `UMAMI_URL` | Yes | Umami instance URL (e.g. `https://analytics.example.com`) |
| `UMAMI_USERNAME` | For self-hosted | Login username |
| `UMAMI_PASSWORD` | For self-hosted | Login password |
| `UMAMI_API_KEY` | For Umami Cloud | API key from Umami Cloud dashboard |