Microsoft Clarity

Microsoft Clarity MCP 服务

这是一个用于 Microsoft Clarity 的 Model Context Protocol (MCP) 服务。 它允许你通过 Claude for Desktop 或其他兼容 MCP 的客户端访问 Clarity 中的会话录制、项目分析和文档。

主要功能

• 分析数据访问：查询你的 Microsoft Clarity 分析数据，包括流量指标、用户行为洞察和性能统计
• 会话录制检索：访问并分析会话录制，以了解用户交互并发现优化机会
• 自然语言查询：用简单的英语提问即可从数据中获取洞察——无需学习复杂的查询语法或 API 端点
• 灵活的数据筛选：按浏览器、设备、国家/地区等多种维度筛选结果
• 实时数据访问：按需从你的 Clarity 项目中获取最新的分析数据和洞察
• 文档集成：直接在工作流中快速获取 Microsoft Clarity 文档中的解答和指导
• 无缝 MCP 集成：与 Claude for Desktop、Visual Studio Code 及其他兼容 Model Context Protocol (MCP) 的客户端原生兼容

设置与安装

前提条件

• Node.js v16 或更高版本
• 一个 Microsoft Clarity 账户和 API 令牌
• 任意兼容 MCP 的客户端（Claude for Desktop 等）

安装

方式 1：通过 npm 安装（推荐）

你可以直接使用 npm 安装并运行此包：

# Install globally
npm install -g @microsoft/clarity-mcp-server

# Run the 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：手动安装

1. 克隆或下载此仓库
2. 安装依赖：

   npm install
   

3. 构建 TypeScript 代码：

   npm run build
   

4. 运行服务：

   npm run start
   

扩展/插件安装

Visual Studio Code 扩展

点击上方按钮，直接在 Visual Studio Code 中安装 Microsoft Clarity MCP 服务。

Claude Desktop 插件

从 Claude 的扩展库中安装：

1. 打开 Claude Desktop
2. 前往 File → Settings → Extensions
3. 搜索 Microsoft Clarity
4. 点击 Install 添加该扩展
5. 配置你的 API Token：
   按照 API Token 部分中的说明获取并正确设置它。

配置

你可以通过两种方式提供 Clarity 数据导出 API 令牌：

1. 命令行参数：

   npx @microsoft/clarity-mcp-server --clarity_api_token=your-token
   

2. 工具参数：
   在调用 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 使用此服务：

1. 打开你的 Claude for Desktop 配置文件：
   • Windows：%AppData%\Claude\claude_desktop_config.json
   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
2. 添加上方通用示例中所示的配置
3. 保存配置文件并重启 Claude for Desktop

服务使用

该服务提供多种工具，你可以从任意 MCP 客户端调用它们。 只需自然地提问，并让每个请求专注于一件事。

查询分析仪表板

• 名称： query-analytics-dashboard
• 描述： 使用简化的自然语言搜索查询，从你项目的仪表板中检索分析数据和指标。
• 示例：
  • 过去 3 天我们收到了多少来自埃及的 Clarity 会话？
  • 我的 Clarity 项目中最常用的浏览器有哪些？
  • 向我展示我的 Clarity 项目上周的流量指标

列出会话录制

• 名称： list-session-recordings
• 描述： 根据指定的筛选条件列出你项目的会话录制。这些筛选器允许你按各种字段缩小录制范围，例如 URL、设备类型、浏览器、操作系统、国家、城市等。
• 示例：
  • 列出最近来自移动设备的 Clarity 会话
  • 展示用户点击次数最多的前 5 个 Clarity 会话
  • 获取用户遇到 JavaScript 错误的 Clarity 录制

查询文档资源

• 名称： query-documentation-resources
• 描述： 从 Microsoft Clarity 文档中检索片段，以回答用户的问题，包括设置指南、功能、用法、故障排除和集成说明的分步截图。
• 示例：
  • 如何使用 Microsoft Clarity 跟踪自定义事件？
  • 在 Microsoft Clarity 中，我可以为一条录添加多少个标签？

API 令牌

获取你的 API 令牌

要生成 API 令牌：

1. 转到你的 Clarity 项目
2. 选择 Settings → Data Export → Generate new API token
3. 为令牌提供一个描述性名称
4. 安全地保存生成的令牌

隐私政策

有关数据隐私和使用的信息，请参阅 Microsoft Clarity 隐私政策。

许可证

本项目根据 MIT 许可证授权。