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許可證。