Skip to main content
Glama
Clarity Data Export MCP Server

Clarity Data Export MCP Server

Official
by microsoft

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.

Key Features

  • Analytics Data Access: Query your Microsoft Clarity analytics data including traffic metrics, user behavior insights, and performance statistics

  • Session Recording Retrieval: Access and analyze session recordings to understand user interactions and identify optimization opportunities

  • Natural Language Querying: Ask questions in plain English to get insights from your data - no need to learn complex query syntax or API endpoints

  • Flexible Data Filtering: Filter results by various dimensions such as browser, device, country, and many more

  • Real-Time Data Access: Fetch the latest analytics data and insights from your Clarity projects on-demand

  • Documentation Integration: Get quick answers and guidance from Microsoft Clarity documentation directly within your workflow

  • Seamless MCP Integration: Works natively with Claude for Desktop, Visual Studio Code, and other Model Context Protocol (MCP) compatible clients

Related MCP server: CUT Clarity MCP Server

Setup and Installation

Prerequisites

  • Node.js v16 or higher

  • A Microsoft Clarity account and API token

  • Any MCP-compatible client (Claude for Desktop, etc.)

Installation

You can install and run this package directly using npm:

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

# Run the server
clarity-mcp-server

Option 2: Run with npx without installing

You can run the server directly using npx without installing:

npx @microsoft/clarity-mcp-server

With either option, you can provide your Clarity API token using the --clarity_api_token parameter:

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

Option 3: Manual Installation

  1. Clone or download this repository

  2. Install dependencies:

    npm install
  3. Build the TypeScript code:

    npm run build
  4. Run the server:

    npm run start

Extension/Plugin Installation

Visual Studio Code Extension

Click the button above to install the Microsoft Clarity MCP server directly in Visual Studio Code.

Claude Desktop Plugin

Install from Claude's extension gallery:

  1. Open Claude Desktop

  2. Navigate to File → Settings → Extensions

  3. Search for Microsoft Clarity

  4. Click Install to add the extension

  5. Configure your API Token:

Configuration

You can provide the Clarity data export API token in two ways:

  1. Command Line Arguments:

    npx @microsoft/clarity-mcp-server --clarity_api_token=your-token
  2. Tool Parameters:

Configuring MCP Clients

Generic MCP Client Configuration

MCP clients typically require configuration to connect to the server. Here's a general example of how to configure an MCP client:

{
  "mcpServers": {
    "@microsoft/clarity-mcp-server": {
      "command": "npx",
      "args": [
        "@microsoft/clarity-mcp-server",
        "--clarity_api_token=your-api-token-here"
      ]
    }
  }
}

The specifics of where and how to add this configuration will depend on your specific MCP client.

Claude for Desktop Configuration

To configure Claude for Desktop to use this server:

  1. Open your Claude for Desktop configuration file:

    • Windows: %AppData%\Claude\claude_desktop_config.json

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  2. Add the configuration shown in the generic example above

  3. Save the configuration file and restart Claude for Desktop

Server Usage

The server exposes various tools that you can call from any MCP client. Just ask naturally and keep each request focused on one thing.

Query Analytics Dashboard

  • Name: query-analytics-dashboard

  • Description: Retrieves analytics data and metrics from your project's dashboard using a simplified natural language search query.

  • Examples:

    • How many Clarity sessions did we get from Egypt in the past 3 days?

    • What are the most used browsers in my Clarity project?

    • Show me traffic metrics from my Clarity project for the last week

List Session Recordings

  • Name: list-session-recordings

  • Description: Lists your project's session recordings based on a specified filtering criteria. The filters allow you to narrow down the recordings by various fields such as URLs, device types, browser, OS, country, city, and more.

  • Examples:

    • List the most recent Clarity sessions from mobile devices

    • Show the top 5 Clarity sessions with the highest number of user clicks

    • Get Clarity recordings where users encountered JavaScript errors

Query Documentation Resources

  • Name: query-documentation-resources

  • Description: Retrieves snippets from Microsoft Clarity documentation to find answers to user questions including step-by-step screenshots for setup guides, features, usage, troubleshooting, and integration instructions.

  • Examples:

    • How to track custom events using Microsoft Clarity?

    • How many labels can I add to a recording in Microsoft Clarity?

API Token

Getting Your API Token

To generate an API token:

  1. Go to your Clarity project

  2. Select Settings → Data Export → Generate new API token

  3. Provide a descriptive name for the token

  4. Save the generated token securely

Privacy Policy

For information about data privacy and usage, please refer to the Microsoft Clarity Privacy Policy.

License

This project is licensed under the MIT License.

Available Tools

3 tools
list-session-recordingsA
Read-only

List Microsoft Clarity session recordings based on specified filters. The filters allow you to narrow down the recordings by various criteria such as URLs, device types, browser, OS, country, city, and more. The date filter is required and must be in UTC ISO 8601 format.

Inputs: filters (required), sortBy, count.

query-analytics-dashboardA
Read-only

Fetch Microsoft Clarity analytics data using a simplified natural language search query. The query should be focused on one specific data retrieval or aggregation task. Avoid complex multi-purpose queries. Time ranges should be explicitly specified when possible. If no time range is provided, prompt the user to specify one.

Inputs: query (required).

query-documentation-resourcesA
Read-only

Retrieve Microsoft Clarity documentation snippets for finding answers to user questions including step-by-step screenshots for setup guides, features, usage, troubleshooting, and integration instructions. The query should be focused on one specific documentation topic or question. Avoid complex multi-purpose queries.

Inputs: query (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.7/5.0

    Scored across 3 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: list-session-recordings retrieves session data with filters, query-analytics-dashboard fetches analytics via natural language queries, and query-documentation-resources retrieves documentation snippets. There is no overlap in functionality, making it easy for an agent to select the correct tool.

    Naming Consistency5/5

    All tool names follow a consistent verb-noun pattern with hyphens (list-session-recordings, query-analytics-dashboard, query-documentation-resources). The naming is predictable and readable, with no deviations in style or convention.

    Tool Count3/5

    With only 3 tools, the server feels thin for a data export domain that might benefit from more granular operations like exporting specific data formats or managing exports. However, the tools cover core areas, so it's borderline but not severely lacking.

    Completeness4/5

    The tools provide good coverage for listing, querying analytics, and accessing documentation, but there are minor gaps such as missing explicit export or download functionality for data, which could limit agent workflows. Overall, it supports key tasks without major dead ends.

    Maintenance

    ActivityInactive
    ResponsivenessMixed handling

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      D
      maintenance
      A powerful Model Context Protocol (MCP) server that provides comprehensive Google Analytics 4 (GA4), Google Search Console (GSC), and Google Merchant Center (GMC) integration for Claude Desktop and other MCP clients.
      Apache 2.0
    • A
      license
      Not graded
      quality
      D
      maintenance
      MCP server for Microsoft Clarity Data Export API, providing tools to retrieve traffic, popular pages, engagement metrics, and user behavior insights such as dead clicks, rage clicks, and script errors. Supports multiple projects with daily quota management and shared caching.
      MIT
    • A
      license
      A
      quality
      D
      maintenance
      Bridges Microsoft Clarity's analytics API with Claude, enabling custom date ranges and page-level filtering on top of Clarity's native limitations.
      3
      MIT