API VEGA

Microsoft Clarity MCP Server

This is a Model Context Protocol (MCP) server for the Microsoft Clarity.

It allows you to access your session recordings, project analytics, and documentation from Clarity using Claude for Desktop or other MCP-compatible clients.

Ключевые возможности

  • Доступ к аналитическим данным: Получайте данные аналитики 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 токен с помощью параметра:

npx @microsoft/clarity-mcp-server --clarity_api_token=your-token-here
Вариант 3: Ручная установка

  • Клонируйте или загрузите этот репозиторий

  • Установить зависимости:

npm install
  • Собрать код TypeScript:
npm run build
  • Запустите сервер:
npm run start

Установка расширения/плагина

Расширение Visual Studio Code

Нажмите кнопку выше, чтобы установить Microsoft Clarity MCP-сервер непосредственно в Visual Studio Code.

Плагин Claude Desktop

Установите из галереи расширений Claude:

  • Откройте Claude Desktop

  • Перейдите в File → Settings → Extensions

  • Найдите Microsoft Clarity

  • Нажмите Install для добавления расширения

  • Настройте ваш API токен:

Следуйте инструкциям в разделе API токен для корректного получения и настройки.

Конфигурация

Вы можете указать токен экспорта данных Clarity API двумя способами:

  • Командная строка:
npx @microsoft/clarity-mcp-server --clarity_api_token=your-token
  • Параметры инструмента:

Укажите token в качестве параметра при вызове инструментa get-clarity-data

Настройка 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 мы получили из Египта за последние 3 дня?

  • Какие браузеры используются чаще всего в моём проекте Clarity?

  • Покажите показатели трафика моего проекта Clarity за прошедшую неделю

Список записей сессий

  • Название: list-session-recordings

  • Описание: Перечисляет записи сессий вашего проекта на основе заданных критериев фильтрации. Фильтры позволяют сузить записи по таким полям, как URL, тип устройства, браузер, ОС, страна, город и многим другим.

  • Примеры:

Перечислите последние сессии Clarity с мобильных устройств

  • Покажите топ-5 сессий Clarity с наибольшим количеством кликов пользователей

  • Получите записи Clarity, где пользователи столкнулись с ошибками JavaScript

Поиск ресурсов документации

  • Название: query-documentation-resources

  • Описание: Извлекает фрагменты из документации Microsoft Clarity для ответа на вопросы пользователя, включая пошаговые скриншоты по настройке, функциям, использованию, устранению неполадок и инструкциям по интеграции.

  • Примеры:

Как отслеживать пользовательские события с использованием Microsoft Clarity?

Сколько ярлыков можно добавить к записи в Microsoft Clarity?

API токен

Получение вашего API токена

Чтобы сгенерировать API токен:

  • Перейдите в ваш проект Clarity

  • Выберите Settings → Data Export → Generate new API token

  • Укажите описательное имя токена

  • Надёжно сохраните сгенерированный токен

Политика конфиденциальности

Для информации о конфиденциальности данных и их использовании, пожалуйста, ознакомьтесь с Политикой конфиденциальности Microsoft Clarity: https://clarity.microsoft.com/privacy

Лицензия

Этот проект распространяется по MIT License.