Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| UMAMI_URL | Yes | Your Umami instance URL (e.g. https://analytics.example.com) | |
| UMAMI_API_KEY | No | API key from Umami Cloud dashboard | |
| UMAMI_PASSWORD | No | Login password for self-hosted instances | |
| UMAMI_USERNAME | No | Login username for self-hosted instances |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_websites | List all websites tracked in Umami |
| get_website | Get details of a specific website by ID |
| create_website | Create a new website to track in Umami |
| update_website | Update an existing website's configuration |
| delete_website | Delete a website from Umami |
| get_active_visitors | Get the number of currently active visitors on a website |
| reset_website | Reset a website by removing all its analytics data (irreversible) |
| transfer_website | Transfer website ownership to another user |
| get_website_reports | Get all reports associated with a specific website |
| get_stats | Get summary statistics for a website (pageviews, visitors, visits, bounces, totaltime) |
| get_pageviews | Get pageview and session counts over time for a website |
| get_metrics | Get aggregated metrics for a website (e.g. top pages, browsers, countries, devices, OS, events) |
| get_events | Get event data for a website over time |
| get_sessions | Get session data for a website |
| get_daterange | Get the date range of available data for a website |
| get_event_series | Get event metrics over time (event series data) for a website |
| get_session_stats | Get summarized session statistics for a website (total sessions, unique visitors, etc.) |
| get_sessions_weekly | Get weekly session data for a website |
| get_session | Get details of a specific session |
| get_session_activity | Get activity log for a specific session (pages visited, events fired) |
| get_session_properties | Get custom properties attached to a specific session |
| get_session_data_properties | Get session data property names and their data types for a website |
| get_session_data_values | Get session data values (aggregated counts for session properties) for a website |
| send_event | Send a custom event or pageview to Umami (useful for server-side tracking) |
| get_event_values | Get event or session property values for a website |
| get_event_data_events | Get event data events (custom event names and counts) for a website |
| get_event_data_fields | Get event data fields (property keys and their data types) for a website |
| get_event_data_values | Get event data values (aggregated counts for a specific property) for a website |
| get_event_data_stats | Get event data statistics (summary counts) for a website |
| batch_events | Send multiple events or pageviews in a single batch request |
| list_reports | List all saved reports |
| get_report | Get details of a specific saved report |
| create_report | Create and save a new report |
| update_report | Update an existing saved report |
| delete_report | Delete a saved report |
| run_report | Execute a report by type and get results (funnel, retention, utm, goals, insights, revenue, journey, attribution) |
| list_users | List all users (admin only) |
| create_user | Create a new user (admin only) |
| get_user | Get details of a specific user (admin only) |
| update_user | Update a user's username, password, or role (admin only) |
| delete_user | Delete a user (admin only) |
| get_user_websites | Get the list of websites a user has access to (admin only) |
| get_user_usage | Get usage statistics for a specific user (admin only) |
| get_user_teams | Get the list of teams a user belongs to (admin only) |
| list_teams | List all teams |
| create_team | Create a new team |
| get_team | Get details of a specific team |
| update_team | Update a team's name |
| delete_team | Delete a team |
| join_team | Join a team using an access code |
| list_team_users | List all members of a team |
| add_team_user | Add a user to a team |
| update_team_user | Update a team member's role |
| get_team_user | Get details of a specific team member |
| remove_team_user | Remove a user from a team |
| list_team_websites | List all websites that belong to a team |
| add_team_website | Add a website to a team |
| remove_team_website | Remove a website from a team |
| get_realtime | Get real-time data for a website (last 30 minutes). Returns current visitors, active URLs, referrers, countries, and events. |
| get_me | Get the currently authenticated user's profile information |
| get_my_websites | Get the list of websites belonging to the current user |
| get_my_teams | Get the list of teams the current user belongs to |
| update_my_password | Update the current user's password |
| verify_auth | Verify the current authentication token is valid |
| get_share | Get shared website data by share ID (public access, no auth required for the share itself) |
| heartbeat | Check if the Umami server is running and healthy |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| site_overview | Comprehensive overview of a website's analytics — fetches stats, pageviews, top pages, and active visitors |
| traffic_compare | Compare traffic between two date ranges to identify trends |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| websites | List of all websites tracked in Umami |
| account | Current authenticated Umami user info |