Clarity MCP Server

🚀 微软Clarity数据导出MCP服务器

这是一个用于微软Clarity数据导出API的模型上下文协议（MCP）服务器。借助它，你可以使用桌面版Claude或其他兼容MCP的客户端从Clarity获取分析数据。

✨ 主要特性

• 通过简单的接口查询微软Clarity分析数据。
• 最多可按3个维度（浏览器、设备、国家/地区、操作系统等）进行过滤。
• 检索各种指标（滚动深度、参与时间、流量等）。
• 与桌面版Claude和其他MCP客户端无缝集成。

📦 安装指南

前提条件

• Node.js v16或更高版本。
• 一个微软Clarity账户和API令牌。
• 任何兼容MCP的客户端（如桌面版Claude等）。

安装方式

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

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

# 全局安装
npm install -g @microsoft/clarity-mcp-server

# 运行服务器
clarity-mcp-server

方式二：使用npx直接运行，无需安装

你可以使用npx直接运行服务器，而无需安装：

npx @microsoft/clarity-mcp-server

无论使用哪种方式，你都可以使用 --clarity_api_token 参数提供你的Clarity API令牌：

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

方式三：手动安装

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

   npm install
   

3. 构建TypeScript代码：

   npm run build
   

4. 运行服务器：

   npm start
   

📚 详细文档

配置API令牌

你可以通过以下两种方式提供 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配置

要配置桌面版Claude以使用此服务器，请按以下步骤操作：

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

使用服务器

当使用配置了此服务器的MCP客户端时，你可以要求它获取Clarity数据。例如： “你能获取我过去一天的Clarity数据吗？按浏览器过滤并显示流量指标。” 然后，MCP客户端将提示你运行 get-clarity-data 工具，该工具需要以下参数：

• numOfDays：要检索的天数（1 - 3天）。
• dimensions：用于过滤的维度数组（可选）。
• metrics：要检索的指标数组（可选）。 如果你尚未通过命令行参数配置凭据，则还需要提供：
• token：你的Clarity API令牌。

获取API令牌

要生成API令牌，请按以下步骤操作：

1. 进入你的Clarity项目。
2. 选择“设置” -> “数据导出” -> “生成新的API令牌”。
3. 为令牌提供一个描述性名称。
4. 安全地保存生成的令牌。

限制

• 每个项目每天最多允许10次API请求。
• 数据检索范围限于前1到3天。
• 单个请求最多可传递三个维度。
• 响应限制为1000行，且无法分页。

📄 许可证

本项目采用MIT许可证。