Umami MCP Server — 89 tools
The Umami DADL turns Umami's API into an MCP server that Claude, GPT or any MCP-compatible agent can consume directly. One YAML file declares all 89 tools — website, team, event, session, user, link, and more — and ToolMesh serves them at runtime. No Python boilerplate, no per-endpoint code, no separate MCP server process.
Below: the endpoint coverage matrix, a two-block ToolMesh setup, the full tool reference grouped by Umami feature area, required credential scopes.
Source: Umami Analytics REST API
Which Umami endpoints are covered?
100% (89 of ~89 endpoints)
Focus: authentication, me, websites, statistics, metrics, pageviews, events, event-data, sessions, session-data, realtime, users, teams, reports, share, links, pixels, admin
Missing: none
How do you configure the Umami DADL?
- Log into your Umami instance as admin
- Navigate to Settings → Users or use the API login endpoint
- POST /api/auth/login with {username, password} to get a JWT token
- The token is returned in the response body as 'token'
Environment variable: CREDENTIAL_UMAMI_API_TOKEN
Umami is self-hosted. Replace the URL with your instance address. Token is a JWT obtained via /auth/login.
How do you install the Umami MCP server with ToolMesh?
Add to your backends.yaml:
- name: umami
transport: rest
dadl: umami.dadl
url: "https://your-umami-instance.com/api"
Set the credential:
CREDENTIAL_UMAMI_API_TOKEN=your-token-hereWhat 89 tools does the Umami DADL expose?
POSTloginAuthenticate with Umami. Returns a JWT token for subsequent API calls. Send username and password in the request body.POSTverify_tokenVerify if the current JWT token is still valid. Returns user info if valid.GETget_meGet the current authenticated user's profile info based on the JWT token.GETget_my_teamsGet all teams the current authenticated user belongs to.GETget_my_websitesWebsites of the current user -- same semantics as list_websites: only directly owned websites unless includeTeams is true, which adds the websites of the user's teams. Returns {data, count, page, pageSize}. For every website on the instance use admin_list_websites (admin role).
POSTsend_eventRegister a pageview or custom event. No authentication required. Requires a User-Agent header. Used by the tracking script.GETlist_websitesList websites OWNED BY THE CALLING USER (userId = token user). Websites that belong to a team are NOT included unless includeTeams is true (then: all websites of teams the user is a member of). An empty result therefore usually means the websites are team-owned -- retry with includeTeams: true, or use admin_list_websites (admin role, every website on the instance) / list_team_websites(teamId). Returns {data: [...], count, page, pageSize}; each item has id (websiteId), name, domain, teamId, createdAt.
GETget_websiteGet details of a specific website by its ID.POSTcreate_websiteCreate a new website to track. Provide name and domain.POSTupdate_websiteUpdate website properties. Only include fields you want to change.POSTtransfer_websiteTransfer a website to a different user or team. IMPORTANT: Only the current owner of the website can transfer it — there is no admin bypass. Use teamId to assign to a team (requester must own the website and be a team member with transfer permission). Use userId to claim a team-owned website back to yourself (requester must be in the team with transfer permission). To remove from a team, pass teamId: null.DELETEdelete_websiteDelete a website and all its analytics data. Irreversible.POSTreset_websiteReset a website by removing all its analytics data. The website itself is preserved but all stats are deleted. Irreversible.GETget_website_activeGet the number of active visitors on a website right now (last 5 minutes).GETget_website_daterangeGet the date range of available analytics data for a website.GETget_website_statsGet summarized website statistics: pageviews, visitors, visits, bounces, and total time. Timestamps are Unix milliseconds.GETget_website_pageviewsGet pageview time series within a given time range. Returns pageviews and sessions arrays with timestamps. Unit auto-scales if range exceeds maximum for chosen unit.GETget_website_metricsGet metrics for a website grouped by type (Umami v3 vocabulary): path, fullPath (path incl. query string), entry, exit, referrer, domain (referrer domain), title, query, event, tag, hostname, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, browser, os, device, screen, language, country, city, region, distinctId, channel. Any other value -- notably the Umami v2 name "url" -- is rejected with HTTP 400; use "path" for page URLs. Returns [{x: value, y: count}] sorted by y desc, limit/offset apply (channel ignores them). startAt/endAt are Unix MILLISECONDS.
GETget_website_metrics_expandedExpanded metrics per entry: returns [{name, pageviews, visitors, visits, bounces, totaltime}] (NOT the {x, y} shape of get_website_metrics; region/city rows also carry country). type accepts the same Umami v3 vocabulary as get_website_metrics: path, fullPath (path incl. query string), entry, exit, referrer, domain (referrer domain), title, query, event, tag, hostname, utmSource, utmMedium, utmCampaign, utmContent, utmTerm, browser, os, device, screen, language, country, city, region, distinctId, channel. Anything else (e.g. the v2 name "url") returns HTTP 400 -- use "path". bounces and totaltime are always 0 for page/event types (path, referrer, title, ...) and only populated for session types (country, browser, ...) and channel; numeric fields may arrive as strings. startAt/endAt are Unix MILLISECONDS.
GETget_website_eventsGet custom event details for a website within a time range.GETget_website_events_seriesGet custom events within a time range as time series. Returns [{x: event_name, t: timestamp, y: count}].GETget_website_events_statsGet aggregated event statistics for a website within a time range.GETget_event_dataGet event data grouped by name for a website.GETget_event_data_by_idGet event data for a specific individual event.GETget_event_data_eventsGet event names and their property counts.GETget_event_data_fieldsGet event property names and their value counts.GETget_event_data_propertiesGet event names and their associated property counts.GETget_event_data_valuesGet event data counts for a specific event and property combination.GETget_event_data_statsGet aggregated event data statistics: total events, properties, and records count.GETlist_sessionsList sessions for a website within a time range.GETget_sessions_statsGet aggregated session statistics for a website.GETget_sessions_weeklyGet sessions grouped by hour-of-weekday (heatmap data).GETget_sessionGet details of a specific session.GETget_session_activityGet activity log for a specific session (pageviews, events).GETget_session_propertiesGet custom properties stored for a specific session.GETget_session_data_propertiesGet session data counts grouped by property name.GETget_session_data_valuesGet session data counts for a specific property.GETget_realtimeGet realtime statistics for a website (last 30 minutes). Returns countries, urls, referrers, events, series, totals, and timestamp.POSTcreate_userCreate a new user. Admin only. Roles: admin, user, view-only.GETget_userGet a user by ID. Admin only.POSTupdate_userUpdate a user. Admin only. Only include fields you want to change.DELETEdelete_userDelete a user. Admin only. Irreversible.GETget_user_websitesGet all websites accessible by a specific user.GETget_user_teamsGet all teams a specific user belongs to.GETlist_teamsList all teams.POSTcreate_teamCreate a new team.POSTjoin_teamJoin a team using an access code.GETget_teamGet a team by ID.POSTupdate_teamUpdate team properties. Only include fields you want to change.DELETEdelete_teamDelete a team. Irreversible.GETlist_team_usersList all members of a team.POSTadd_team_userAdd a user to a team. Roles: team-member, team-view-only, team-manager.GETget_team_userGet a specific team member.POSTupdate_team_userUpdate a team member's role.DELETEremove_team_userRemove a user from a team.GETlist_team_websitesList all websites assigned to a team.GETlist_reportsList all reports for a website.POSTcreate_reportCreate a new report.GETget_reportGet a report by ID.POSTupdate_reportUpdate a report.DELETEdelete_reportDelete a report. Irreversible.POSTrun_attribution_reportRun an attribution report. Models: firstClick, lastClick. Types: path, event.POSTrun_breakdown_reportRun a breakdown report to cross-reference multiple dimensions.POSTrun_funnel_reportRun a funnel report. Requires at least 2 steps, each with type (path/event) and value.POSTrun_goal_reportRun a goal report. Type: path or event.POSTrun_journey_reportRun a journey/path report. Steps must be 3-7.POSTrun_performance_reportRun a web vitals performance report. Metrics: lcp, inp, cls, fcp, ttfb.POSTrun_retention_reportRun a retention/cohort report.POSTrun_revenue_reportRun a revenue report.POSTrun_utm_reportRun a UTM campaign report.POSTcreate_shareCreate a share page. Share types: 1=website, 2=link, 3=pixel, 4=board.GETget_shareGet a share page by its ID.POSTupdate_shareUpdate a share page.DELETEdelete_shareDelete a share page. Irreversible.GETlist_website_sharesList all share pages for a website.POSTcreate_website_shareCreate a share page for a specific website.GETlist_linksList all tracked links.POSTcreate_linkCreate a tracked link. Slug must be at least 8 characters.GETget_linkGet a tracked link by ID.POSTupdate_linkUpdate a tracked link.DELETEdelete_linkDelete a tracked link. Irreversible.GETlist_pixelsList all tracking pixels.POSTcreate_pixelCreate a tracking pixel. Slug must be at least 8 characters.GETget_pixelGet a tracking pixel by ID.POSTupdate_pixelUpdate a tracking pixel.DELETEdelete_pixelDelete a tracking pixel. Irreversible.GETadmin_list_usersList all users in the Umami instance. Admin only.GETadmin_list_websitesList EVERY website on the instance regardless of owner or team (requires the admin role). This is the reliable way to find a websiteId when list_websites / get_my_websites come back empty because the websites are team-owned. Returns {data, count, page, pageSize}; items include id, name, domain, user and team.
GETadmin_list_teamsList all teams in the Umami instance. Admin only.