项目介绍
Microsoft Clarity MCP 服务器
这是一个用于 Microsoft Clarity 的模型上下文协议(MCP)服务器。它允许您通过 Claude for Desktop 或其他兼容 MCP 的客户端访问您的会话录制、项目分析和文档。
主要功能
- 分析数据访问:查询您的 Microsoft Clarity 分析数据,包括流量指标、用户行为洞察和性能统计。
- 会话录制检索:访问并分析会话录制以了解用户交互并识别优化机会。
- 自然语言查询:用简单的英语提问以获取数据洞察——无需学习复杂的查询语法或 API 端点。
- 灵活的数据过滤:根据浏览器、设备、国家等不同维度过滤结果。
- 实时数据分析:按需获取最新分析数据和洞察。
- 文档集成:在工作流中直接从 Microsoft Clarity 文档获得快速答案和指导。
- 无缝 MCP 集成:原生支持 Claude for Desktop、Visual Studio Code 和其他兼容 MCP 协议的客户端。
安装与设置
先决条件
- Node.js v16 或更高版本
- 一个 Microsoft Clarity 账户和 API 令牌
- 任何兼容 MCP 的客户端(如 Claude for Desktop)
安装
方案 1:通过 npm 安装(推荐)
您可以直接使用 npm 安装并运行此包:
# 全局安装
npm install -g @microsoft/clarity-mcp-server
# 运行服务器
clarity-mcp-server
方案 2:使用 npx 直接运行
您可以不进行安装而直接使用 npx 运行服务器:
npx @microsoft/clarity-mcp-server
无论选择哪种方式,您都可以通过 --clarity_api_token 参数提供您的 Clarity API 令牌:
npx @microsoft/clarity-mcp-server --clarity_api_token=your-token-here
方案 3:手动安装
- 克隆或下载此仓库
- 安装依赖项:
npm install
- 构建 TypeScript 代码:
npm run build
- 运行服务器:
npm run start
扩展/插件安装
Visual Studio Code 扩展
<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install+Server&color=0098FF" alt="在 VS Code 中安装">
点击上方按钮直接在 Visual Studio Code 中安装 Microsoft Clarity MCP 服务器。
Claude Desktop 插件
从 Claude 的扩展画廊安装:
- 打开 Claude Desktop
- 导航到 文件 → 设置 → 扩展
- 搜索 Microsoft Clarity
- 点击 安装 添加扩展
- 配置您的 API 令牌:
<br>
按照 API 令牌部分 的说明来正确获取并设置。
配置
您可以通过两种方式提供 Clarity 数据导出 API 令牌:
-
命令行参数:
npx @microsoft/clarity-mcp-server --clarity_api_token=your-token
-
工具参数:
<br>
在调用 get-clarity-data 工具时提供 token 参数。
配置 MCP 客户端
通用 MCP 客户端配置
MCP 客户端通常需要配置以连接到服务器。这里是一个通用示例,展示如何配置 MCP 客户端:
{
"mcpServers": {
"@microsoft/clarity-mcp-server": {
"command": "npx",
"args": [
"@microsoft/clarity-mcp-server",
"--clarity_api_token=your-api-token-here"
]
}
}
}
具体在哪里以及如何添加此配置取决于您的特定 MCP 客户端。
Claude for Desktop 配置
要配置 Claude for Desktop 使用此服务器:
- 打开您的 Claude for Desktop 配置文件:
- Windows:
%AppData%\Claude\claude_desktop_config.json
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- 添加上述通用示例中的配置
- 保存配置文件并重启 Claude for Desktop
服务器使用
服务器提供了各种工具,您可以从任何 MCP 客户端调用这些工具。
只需自然地提问,并确保每个请求都专注于一件事。
查询分析仪表板
- 名称:
query-analytics-dashboard
- 描述:使用简化的自然语言搜索查询从您的项目仪表板检索分析数据和指标。
- 示例:
- 我们在过去三天里从埃及获得了多少 Clarity 会话?
- 我的 Clarity 项目中最常用的浏览器是什么?
- 显示我 Clarity 项目过去一周的流量指标
列出会话录制
- 名称:
list-session-recordings
- 描述:基于指定的筛选标准列出您的项目会话录制。筛选器允许您通过 URL、设备类型、浏览器、操作系统、国家、城市等字段缩小录制范围。
- 示例:
- 列出最近的移动设备 Clarity 会话
- 显示点击次数最高的前五个 Clarity 会话
- 获取用户遇到 JavaScript 错误的 Clarity 录制
查询文档资源
- 名称:
query-documentation-resources
- 描述:从 Microsoft Clarity 文档中检索片段,以找到用户问题的答案,包括设置指南、功能、使用方法、故障排除和集成说明的逐步截图。
- 示例:
- 如何使用 Microsoft Clarity 跟踪自定义事件?
- 在 Microsoft Clarity 中我可以给录制添加多少标签?
API 令牌
获取您的 API 令牌
要生成 API 令牌:
- 前往您的 Clarity 项目
- 选择 设置 → 数据导出 → 生成新的 API 令牌
- 为令牌提供描述性名称
- 安全地保存生成的令牌
隐私政策
有关数据隐私和使用的更多信息,请参阅 Microsoft Clarity 隐私政策。
许可证
本项目采用 <b>MIT</b> 许可证。