clarity: Instructions file for GitHub Copilot

.github/copilot-instructions.md

clarity copilot-instructions.md is an instructions file for GitHub Copilot from microsoft/clarity. It costs 1,630 tokens per session, scanned A, original, MIT.

Repository guidance for Microsoft Clarity, an open-source TypeScript library that records user interactions and session replays. It covers several related packages in one shared codebase.

In plain words
What is it for?
Use it when changing Clarity's tracking library, decoder, session-replay viewer, or development setup. It also explains how to build, install, and test the repository.
Why use it?
It gives coding agents the project context, development commands, and priorities for keeping Clarity fast and its browser code small.

Instructions file for GitHub Copilot ✓ vendor

Written for GitHub Copilot: a Copilot instructions file.

This is microsoft/clarity's own configuration. It tells GitHub Copilot how to work on clarity itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything clarity configures →

About the project

Microsoft Clarity is an open-source TypeScript library that records website interactions and layout changes so they can be analyzed as behavioral data and replayed as sessions. Website developers use its instrumentation, decoding, visualization, and browser-devtools components to understand how users navigate and interact with sites while emphasizing privacy and performance. The catalogue entries provide agent instructions and an MCP integration for working with Clarity.

microsoft/clarity · 2,781 stars · on GitHub · clarity.microsoft.com

Reuse

Borrowing it

Nothing to install: this file belongs to microsoft/clarity. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/microsoft/clarity/master/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/microsoft/clarity

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for clarity copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/microsoft/clarity/copilot-instructions/github.svg)](https://agentmods.dev/instructions/microsoft/clarity/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/microsoft/clarity/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/microsoft/clarity/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for clarity copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/microsoft/clarity/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/microsoft/clarity/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,630 This file is loaded in full into every session.
When invoked 1,630 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01630 $0.01630
Opus 5.5 $0.00652 $0.00652
Sonnet 5.5 $0.00326 $0.00326
Haiku 4.5 $0.00163 $0.00163

Measured 2mo ago against content hash f537e8a57550, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

clarity copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.github/copilot-instructions.md · 143 lines

How it starts

The opening of the file, as written. The whole thing — 143 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Clarity Repository - Copilot Agent Instructions

Repository Overview

Clarity is an open-source TypeScript behavioral analytics library for tracking user interactions and session replays. Monorepo with Lerna/Yarn workspaces:

  • clarity-js (packages/clarity-js): Core instrumentation library
  • clarity-decode (packages/clarity-decode): Data decoder
  • clarity-visualize (packages/clarity-visualize): Session replay visualization
  • clarity-devtools (packages/clarity-devtools): Chrome extension (private)

Stack: TypeScript, Rollup, TSLint, Playwright, Lerna, Yarn workspaces

clarity-js Performance & Bundle Size Priorities

Critical: clarity-js has two top priorities that must guide all development decisions:

  1. Performance - As an analytics library running on diverse websites, clarity-js must not hurt website performance or impact metrics like INP (Interaction to Next Paint) or PLT (Page Load Time). Balance data collection needs with:

    • Avoid blocking the main thread
    • Minimize network requests
    • Reduce payload size
  2. Bundle Size - Small bundle size is crucial for loading clarity-js quickly and starting data collection as soon as possible. Every byte matters.

Build & Development Commands

Installation

ALWAYS run yarn install before building or testing. (~25s, peer dependency warnings are normal)

Building

yarn build              # All packages (~45s, Lerna parallel build)
yarn build:js           # clarity-js only (~20s)
yarn build:decode       # clarity-decode only
yarn build:visualize    # clarity-visualize only
yarn build:devtools     # clarity-devtools only

Rollup + TypeScript → multiple formats (CJS, ESM, IIFE minified). Build artifacts auto-cleaned to build/ or extension/ (gitignored).

Build outputs per package:

  • clarity-js: clarity.js (CJS), clarity.module.js (ESM), clarity.min.js (minified), plus variants: clarity.extended.js, clarity.insight.js, clarity.performance.js, clarity.livechat.js, and dynamic agent builds (clarity.tidio.js, clarity.crisp.js)
  • clarity-decode: clarity.decode.js (CJS), clarity.decode.module.js (ESM), clarity.decode.min.js (minified)
  • clarity-visualize: clarity.visualize.js (CJS), clarity.visualize.module.js (ESM), clarity.visualize.min.js (minified)
  • clarity-devtools: Output to extension/ directory for Chrome extension

Read the full file on GitHub · 143 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 143 lines · 1,630 tokens per session scan A f537e8a57550

Subscribe to this mod's changes

clarity copilot-instructions.md is an instructions file published in the GitHub repository microsoft/clarity (2,781 stars, last pushed yesterday), licensed MIT. It adds 1,630 tokens to every session, about $0.0065 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

clarity copilot-instructions.md compared with instructions from other repositories

clarity copilot-instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
clarity copilot-instructions.mdmicrosoft/clarityInstructions file2.8kyesterdayMITA1,630GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149ktodayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195ktodayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode