What is contextmine CLAUDE.md?

Repository instructions for ContextMine, a documentation and code-indexing system that makes project information available to AI assistants through MCP, a standard connection method. They include commands for installing dependencies, checking code, running tests, starting the API, and launching the frontend.

Use them to set up ContextMine, run its Python checks and tests, start the API or web app, build the Docker stack, and apply database migrations.

They provide the project’s development commands and explain its multi-package layout, so work can be run and checked from the correct place.

How mayflower/contextmine configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to mayflower/contextmine. 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/mayflower/contextmine/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/mayflower/contextmine

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/mayflower/contextmine/claude-md/github.svg)](https://agentmods.dev/instructions/mayflower/contextmine/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/mayflower/contextmine/claude-md"><img src="https://agentmods.dev/badge/instructions/mayflower/contextmine/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/mayflower/contextmine/claude-md"><img src="https://agentmods.dev/badge/instructions/mayflower/contextmine/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 3,595 This file is loaded in full into every session.

When invoked 3,595 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.

Model	Per session	Once invoked
Fable 5.1	$0.03595	$0.03595
Opus 5.5	$0.01438	$0.01438
Sonnet 5.5	$0.00719	$0.00719
Haiku 4.5	$0.00360	$0.00360

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

Security

Grade A, and why

contextmine 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 · 338 lines

How it starts

The opening of the file, as written. The whole thing — 338 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.

Build & Development Commands

# Install all Python dependencies (run from repo root)
uv sync --all-packages

# Quality checks (run from repo root)
uv run ruff check .        # Linting
uvx ty check               # Type checking
uv run pytest -v           # Run all tests

# Run a single test
uv run pytest apps/api/tests/test_health.py::test_health_check -v

# Start API server (run from repo root)
uv run uvicorn apps.api.app.main:app --reload --port 8000

# Start frontend dev server (from apps/web)
cd apps/web && npm install && npm run dev

# Docker (full stack)
docker compose up --build

# Database migrations (run from packages/core)
cd packages/core && DATABASE_URL=postgresql+asyncpg://contextmine:contextmine@localhost:5432/contextmine uv run alembic upgrade head

# Run migrations in Docker
docker compose exec api sh -c "cd /app/packages/core && alembic upgrade head"

Architecture Overview

ContextMine is a documentation/code indexing system exposing context via MCP (Model Context Protocol).

Monorepo Structure

apps/api: FastAPI backend with MCP server mounted at /mcp
apps/web: React frontend (Vite) admin console
apps/worker: Prefect worker for background sync jobs
packages/core: Shared Python library (settings, DB models, services)
rust/spider_md: Rust-based web crawler binary (HTML→Markdown)

Python Workspace

Uses uv workspaces. The root pyproject.toml defines:

Workspace members: apps/api, apps/worker, packages/*
Dev dependencies: ruff, ty, pytest, httpx
Shared source: contextmine-core package

API Structure

FastAPI app (apps/api/app/main.py) mounts:

REST routes under /api/* (health, auth, collections, sources, etc.)
MCP server at /mcp using Streamable HTTP transport

MCP exposes tools: get_markdown (semantic search), list_collections, list_documents, outline, find_symbol, definition, references, expand, deep_research.

Read the full file on GitHub · 338 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.

2mo ago First seen · 338 lines · 3,595 tokens per session scan A 6abf305446cd

Subscribe to this mod's changes

contextmine CLAUDE.md is an instructions file published in the GitHub repository mayflower/contextmine (24 stars, last pushed 4d ago), licensed MIT. It adds 3,595 tokens to every session, about $0.0144 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.

Data and AI

contextmine CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
contextmine CLAUDE.mdmayflower/contextmine	Instructions file	24	4d ago	MIT	A	3,595	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

contextmine: Instructions file for Claude Code