使用说明
umami-mcp-server
MCP server for Umami Analytics — Cloud and self-hosted.
61个只读工具、4个提示和3个资源 主控程序.建立在官方 TypeScript SDK.跑步 npx --无需安装。
快速开始
npx umami-mcp-server
或全局安装:
npm install -g umami-mcp-server
设置
克劳德代码
claude mcp add -e UMAMI_API_KEY=your-api-key umami -- npx -y umami-mcp-server
或添加到 .mcp.json 在项目根目录中:
{
"mcpServers": {
"umami": {
"command": "npx",
"args": ["-y", "umami-mcp-server"],
"env": {
"UMAMI_API_KEY": "your-api-key"
}
}
}
}
克劳德桌面版
设置>开发人员>编辑配置> claude_desktop_config.json:
{
"mcpServers": {
"umami": {
"command": "npx",
"args": ["-y", "umami-mcp-server"],
"env": {
"UMAMI_API_KEY": "your-api-key"
}
}
}
}
光标
.cursor/mcp.json:
{
"mcpServers": {
"umami": {
"command": "npx",
"args": ["-y", "umami-mcp-server"],
"env": {
"UMAMI_API_KEY": "your-api-key"
}
}
}
}
VS代码(副本)
settings.json:
{
"mcp": {
"servers": {
"umami": {
"command": "npx",
"args": ["-y", "umami-mcp-server"],
"env": {
"UMAMI_API_KEY": "your-api-key"
}
}
}
}
}
ChatGPT
ChatGPT通过远程连接支持MCP服务器(需要可公开访问的URL)。
- 将此服务器部署在具有SSE传输的公共HTTPS端点后面(例如使用 mcp遥控器 或类似ngrok的隧道)
- 在ChatGPT中,转到 设置>连接器>高级>开发人员模式
- 添加服务器URL
ChatGPT无法直接连接到本地主机。您需要一个公共URL或隧道。
适用于ChatGPT Pro、团队、企业和教育计划。
OpenAI Codex/Windsurf/Zed
相同模式--命令 npx,args ["-y", "umami-mcp-server"],加上环境变量。
史密瑟里
npx -y @smithery/cli install umami-mcp-server --client claude
自助式Umami
替换 env 在上面的任何配置中阻塞:
{
"UMAMI_URL": "https://your-umami-instance.com",
"UMAMI_USERNAME": "admin",
"UMAMI_PASSWORD": "your-password"
}
环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
UMAMI_API_KEY |
云 | Umami云设置>API密钥中的API密钥 |
UMAMI_API_BASE |
没有 | API基本URL(默认值: https://api.umami.is/v1) |
UMAMI_URL |
自托管 | Umami实例URL |
UMAMI_USERNAME |
自托管 | 登录用户名 |
UMAMI_PASSWORD |
自托管 | 登录密码 |
集 UMAMI_API_KEY 对于云,或 UMAMI_URL + UMAMI_USERNAME + UMAMI_PASSWORD 自托管。自动检测到。
工具
网站统计数据(11)
| 工具 | 说明 |
|---|---|
get_websites |
列出所有带有ID和创建日期的跟踪网站 |
get_website_by_id |
获取特定网站的详细信息 |
get_stats |
汇总统计数据:页面浏览量、访问者、访问量、跳出次数、总时间 |
get_pageviews |
按时间单位划分的时间序列页面浏览量和会话数据 |
get_metrics |
按路径、推荐人、浏览器、操作系统、设备、国家等细分。 |
get_metrics_expanded |
每项统计数据:页面浏览量、访问者、跳出次数、页面停留时间 |
get_active |
当前活跃访客 |
get_daterange |
网站的可用数据日期范围 |
get_realtime |
最后30分钟:访客、网址、推荐人、活动、总计 |
get_website_shares |
列出网站的公共共享页面 |
get_share_by_id |
按ID获取共享页面 |
活动(9)
| 工具 | 说明 |
|---|---|
get_events |
时间范围内的事件详细信息(分页,可搜索) |
get_events_series |
支持时区的随时间变化的事件数据 |
get_events_stats |
聚合事件统计 |
get_event_data_by_id |
特定事件的事件数据 |
get_event_data_events |
事件名称、属性和计数 |
get_event_data_fields |
事件属性和值计数 |
get_event_data_properties |
事件名称和属性计数 |
get_event_data_values |
特定事件/属性组合的计数 |
get_event_data_stats |
总计:事件、属性、记录 |
会议(8)
| 工具 | 说明 |
|---|---|
get_sessions |
会话列表,包括浏览器、操作系统、设备、国家(分页) |
get_sessions_stats |
会话聚合:页面浏览量、访问者、国家/地区、活动 |
get_sessions_weekly |
热图:7天x24小时的会议活动 |
get_session_by_id |
单个会话的详细信息 |
get_session_activity |
会话的活动历史记录(页面、事件) |
get_session_properties |
会话的自定义属性 |
get_session_data_properties |
按属性名称统计会话数据 |
get_session_data_values |
特定属性的会话数据计数 |
报告(11)
| 工具 | 说明 |
|---|---|
get_reports |
列出已保存的报告(可选择按网站筛选) |
get_report_by_id |
按ID获取已保存的报告 |
get_funnel_report |
漏斗分析:分步转换和投放 |
get_retention_report |
随时间变化的访客返回频率 |
get_journey_report |
用户导航流程从起始页开始,经过N个步骤 |
get_utm_report |
UTM活动细分:来源、媒介、活动、期限、内容 |
get_goals_report |
页面浏览和事件目标跟踪 |
get_revenue_report |
按日期范围和货币列出的收入数据 |
get_performance_report |
核心网络生命体征:LCP、INP、CLS、FCP、TTFB |
get_attribution_report |
按来源划分的营销归因 |
get_breakdown_report |
按多个维度细分数据 |
团队(4)
| 工具 | 说明 |
|---|---|
get_teams |
列出所有团队 |
get_team_by_id |
团队详细信息 |
get_team_users |
团队成员和角色 |
get_team_websites |
属于某个团队的网站 |
认证(2)
| 工具 | 说明 |
|---|---|
verify_token |
验证身份验证令牌并获取用户信息 |
get_me |
当前经过身份验证的用户详细信息 |
复合工具(16)
组合多个API调用并返回计算的见解的工具。
| 工具 | 说明 |
|---|---|
compare_periods |
两个时期并存,增长/下降% |
get_visitor_demographics |
一次通话中包含国家、浏览器、操作系统、设备、语言 |
get_traffic_sources |
推荐人、渠道和域名组合 |
get_session_detail |
一次通话中的会话信息+活动+属性 |
get_event_detail |
一次调用中的事件名称+值+时间序列 |
get_site_overview |
统计数据+活跃+首页+来源+国家 |
get_campaign_performance |
UTM+归因组合 |
get_page_analysis |
扩展的页面指标+核心网络重要信息 |
get_growth_trends |
具有加速/减速检测的3周期趋势 |
get_engagement_score |
根据跳出率、时间、页面/访问量得出的参与度得分(0-100) |
get_content_performance |
每页角色分析:入口门、出口门、通道 |
get_acquisition_overview |
推荐人+渠道+登录页面+UTM统一 |
get_bounce_analysis |
按页面、来源和设备列出的最差跳出率 |
get_peak_hours_analysis |
高峰/淡季、最佳日期、发布窗口推荐 |
get_geo_insights |
国家→ 区域→ 城市等级,份额% |
get_realtime_vs_baseline |
当前流量与历史平均值、峰值/下降检测 |
所有工具都是只读的。
资源
| URI | 描述 |
|---|---|
umami://websites |
所有被跟踪的网站 |
umami://teams |
所有团队 |
umami://reports |
所有已保存的报告 |
提示
| 提示 | 说明 | 默认值 |
|---|---|---|
analytics-report |
完整分析报告 | 30天 |
top-pages |
访问量最高的页面 | 7天,前10名 |
visitor-insights |
按国家、设备、浏览器、操作系统分类的访客 | 30天 |
realtime-check |
当前活跃访客 | -- |
查询示例
- “这个月我的前20页是什么?”
- “显示过去90天的访客趋势”
- “我的访客来自哪些国家?”
- “现在我的网站上有多少人?”
- “我哪天哪小时的交通流量最大?”
- “哪些页面的跳出率最高?”
- “将本月的流量与上月进行比较”
- “我过去30天的订婚分数是多少?”
- “在我的注册漏斗中,访问者在哪里下降?”
- “我现在的交通是高于还是低于正常水平?”
运作原理
通过stdio实现MCP(JSON-RPC 2.0)。手柄 initialize, tools/list, tools/call, prompts/list, prompts/get, resources/list, resources/read.向Umami API发出经过身份验证的请求,并返回结构化JSON。
没有后台进程,没有轮询,没有身份验证令牌之外的状态。
兼容性
| 客户端 | 方法 | 状态 |
|---|---|---|
| 克劳德代码 | claude mcp add 或 .mcp.json |
支持 |
| 克劳德桌面 | claude_desktop_config.json 或 .mcpb 扩展 |
支持 |
| 光标 | .cursor/mcp.json |
支持 |
| VS代码(副本) | settings.json |
支持 |
| OpenAI Codex | .mcp.json |
支持 |
| ChatGPT | 远程URL+SSE传输 | 需要公共端点 |
| 风帆/Zed | .mcp.json |
支持 |
| 史密瑟里 | npx @smithery/cli install |
支持 |
需求
- Node.js>=18
- Umami Cloud帐户或自托管实例
许可证
麻省理工学院