hexdocs-mcp: Instructions file for Claude Code

CLAUDE.md

hexdocs-mcp CLAUDE.md is an instructions file for Claude Code from bradleygolden/hexdocs-mcp. It costs 2,253 tokens per session, scanned A, original, MIT.

Repository instructions for HexDocs MCP, a service that searches documentation for Hex packages, which are reusable Elixir software libraries.

In plain words
What is it for?
Working on the HexDocs MCP codebase, including its documentation fetching, search, embeddings, database, and command-line components.
Why use it?
It gives a coding agent the project’s structure, components, and data flow so it can make informed changes.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

README.md
[![agentmods](https://agentmods.dev/badge/instructions/bradleygolden/hexdocs-mcp/claude-md.svg)](https://agentmods.dev/instructions/bradleygolden/hexdocs-mcp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/bradleygolden/hexdocs-mcp/claude-md"><img src="https://agentmods.dev/badge/instructions/bradleygolden/hexdocs-mcp/claude-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,253 This file is loaded in full into every session.
When invoked 2,253 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.02253 $0.02253
Opus 5 $0.01126 $0.01126
Sonnet 5 $0.00451 $0.00451
Haiku 4.5 $0.00225 $0.00225

Measured 7d ago against content hash d1c789d0b175, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-06, from the pricing page.

Security

Grade A, and why

hexdocs-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 7d 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

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

HexDocs MCP is a project that provides semantic search capabilities for Hex package documentation, designed specifically for AI applications. It downloads, processes, and generates embeddings from Hex package documentation and provides a Model Context Protocol (MCP) server for searching.

Architecture

Core Components

  1. Application Entry Points

    • HexdocsMcp.Application - OTP application for development/test environments
    • HexdocsMcp.CLI - Main CLI entry point for both Mix task and standalone executable
    • Mix.Tasks.Hex.Docs.Mcp - Mix task wrapper
  2. Core Modules

    • HexdocsMcp.Embeddings - Generates and searches vector embeddings
    • HexdocsMcp.Docs - Fetches documentation from Hex
    • HexdocsMcp.Markdown - Converts HTML to Markdown
    • HexdocsMcp.Repo - Ecto repository for SQLite database
    • HexdocsMcp.Config - Centralized configuration and dependency injection
    • HexdocsMcp.Ollama - Wrapper for Ollama AI integration
    • HexdocsMcp.MixDeps - Parses mix.exs dependencies
    • HexdocsMcp.Version - Semantic version comparison and filtering
  3. CLI Modules

    • HexdocsMcp.CLI.FetchDocs - Implements fetch_docs command
    • HexdocsMcp.CLI.SemanticSearch - Implements semantic_search command
    • HexdocsMcp.CLI.HexSearch - Implements hex_search command
    • HexdocsMcp.CLI.FulltextSearch - Implements fulltext_search command
    • HexdocsMcp.CLI.CheckEmbeddings - Implements check_embeddings command
    • HexdocsMcp.CLI.Progress - Rich progress indicators
    • HexdocsMcp.CLI.Utils - Shared CLI utilities

Data Flow

  1. Document Fetching: mix hex.docs fetch_docs → HTML files
  2. Conversion: HTML → Markdown using Floki
  3. Chunking: Markdown → Semantic chunks (2000 chars, 200 overlap)
  4. Embedding: Chunks → 384-dimensional vectors via Ollama
  5. Storage: Embeddings → SQLite with vector extension
  6. Search: Query → Embedding → Vector similarity search → Version filtering (latest by default)

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. 7d ago First seen · 238 lines · 2,253 tokens per session scan A d1c789d0b175

Subscribe to this mod's changes

hexdocs-mcp CLAUDE.md is an instructions file published in the GitHub repository bradleygolden/hexdocs-mcp (70 stars, last pushed 1y ago), licensed MIT. It adds 2,253 tokens to every session, about $0.0113 per session on Opus 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

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens