esp32-docs-mcp: Instructions file for Claude Code

CLAUDE.md

esp32-docs-mcp CLAUDE.md is an instructions file for Claude Code from ozonejunkieau/esp32-docs-mcp. It costs 3,501 tokens per session, scanned A, original, MIT.

A set of working instructions for maintaining the esp32-docs-mcp project, including its commands, rules, environment requirements, and current state.

In plain words
What is it for?
Guiding safe development, documentation-corpus updates, tests, and use of the ESP32 documentation search server.
Why use it?
It helps coding agents avoid breaking project-specific assumptions when changing or running the code.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions CLAUDE.md.

This is ozonejunkieau/esp32-docs-mcp's own configuration. It tells Claude Code how to work on esp32-docs-mcp 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 esp32-docs-mcp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to ozonejunkieau/esp32-docs-mcp. 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/ozonejunkieau/esp32-docs-mcp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/ozonejunkieau/esp32-docs-mcp

Made for: Claude Code.

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 esp32-docs-mcp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/ozonejunkieau/esp32-docs-mcp/claude-md/github.svg)](https://agentmods.dev/instructions/ozonejunkieau/esp32-docs-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/ozonejunkieau/esp32-docs-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/ozonejunkieau/esp32-docs-mcp/claude-md/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 esp32-docs-mcp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/ozonejunkieau/esp32-docs-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/ozonejunkieau/esp32-docs-mcp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 3,501 This file is loaded in full into every session.
When invoked 3,501 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.03501 $0.03501
Opus 5.5 $0.01400 $0.01400
Sonnet 5.5 $0.00700 $0.00700
Haiku 4.5 $0.00350 $0.00350

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

Security

Grade A, and why

esp32-docs-mcp CLAUDE.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.

CLAUDE.md · 238 lines

How it starts

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

CLAUDE.md — operating guide

An MCP server exposing semantic search over ESP32 documentation: the ESP-IDF guides and API reference, and the per-chip Technical Reference Manuals. Chunks are embedded locally with MLX and stored in LanceDB.

Python 3.12+, uv only — never pip or uv pip. Flat module layout, no src/.

This file is what you need to work here safely. The reasoning behind the design lives elsewhere, and is worth reading before changing anything structural:

Read For
docs/architecture.md Why the pipelines are shaped this way; what was tried and deleted
docs/trm-latex.md The TRM LaTeX ingest — read before touching latex_parser.py
docs/building-the-corpus.md Running a build or a refresh
docs/development.md The justfile, the tests, the fixtures
docs/usage.md Querying the server and reading results
README.md The public description

Hard rules

Never chunk ESP-IDF .rst sources. The documentation is a build, not a set of files: constants are substituted from soc_caps/Kconfig at build time, only:: branches are selected per target, and the entire API reference is doxygen output that does not exist in the source tree. Consume the XML builder's output — not the .doctrees pickles, which are written before only:: is evaluated. Rationale and the deleted .rst attempt: architecture.md.

That rule does not transfer to the TRM. Its build-time dependencies are shallow and compiling would yield PDFs — less structure, not more. Parsing the LaTeX source is correct there. \ifglobal is build scaffolding, but \iftagged does gate content in 48 files and must be evaluated rather than flattened. See trm-latex.md so it does not get "fixed" back.

Read the full file on GitHub · 238 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 · 238 lines · 3,501 tokens per session scan A a015afc11ce9

Subscribe to this mod's changes

esp32-docs-mcp CLAUDE.md is an instructions file published in the GitHub repository ozonejunkieau/esp32-docs-mcp (0 stars, last pushed 3mo ago), licensed MIT. It adds 3,501 tokens to every session, about $0.0140 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-31.

Related

esp32-docs-mcp CLAUDE.md compared with instructions from other repositories

esp32-docs-mcp CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
esp32-docs-mcp CLAUDE.mdozonejunkieau/esp32-docs-mcpInstructions file03mo agoMITA3,501Claude Code
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file196ktodayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file144ktodayMITA8,130Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file196ktodayMITA5,685GitHub Copilot
langchain AGENTS.mdlangchain-ai/langchainInstructions file150ktodayMITA4,680Codex, OpenCode
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file283ktodayMITA4,342Codex, OpenCode
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file196ktodayMITA3,153GitHub Copilot