mkdocs-mcp-example: Instructions file for Claude Code

CLAUDE.md

mkdocs-mcp-example CLAUDE.md is an instructions file for Claude Code from robmatesick/mkdocs-mcp-example. It costs 1,953 tokens per session, scanned B, original, MIT.

Project instructions for a monorepo that combines an MkDocs Material documentation site with a Python MCP server. A monorepo keeps multiple related components in one repository.

In plain words
What is it for?
Use them when working on the documentation site, MCP server, shared docs, workspace configuration, or the server's documentation-search tools.
Why use it?
They give the coding agent the project's layout, shared documentation sources, dependency setup, and main components before it changes code.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

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 mkdocs-mcp-example CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/robmatesick/mkdocs-mcp-example/claude-md"><img src="https://agentmods.dev/badge/instructions/robmatesick/mkdocs-mcp-example/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,953 This file is loaded in full into every session.
When invoked 1,953 The same file — it is already loaded in full.
Security scan B 1 finding. 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.01953 $0.01953
Opus 5.5 $0.00781 $0.00781
Sonnet 5.5 $0.00391 $0.00391
Haiku 4.5 $0.00195 $0.00195

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

Security

Grade B, and why

mkdocs-mcp-example CLAUDE.md scanned grade B with 1 finding 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.

Asks for rootmediumPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

- Run as `vscode` user (UID/GID 1000) with sudo access
CLAUDE.md · 227 lines

How it starts

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

This is a monorepo demonstrating the integration of MkDocs Material documentation with a Model Context Protocol (MCP) server. The project uses uv for dependency management and follows a workspace architecture with two main components.

Architecture

Workspace Structure

  • Root: uv workspace configuration (pyproject.toml) with shared development tools (ruff, mypy, pytest, pre-commit)
  • mkdocs-site/: MkDocs Material configuration (mkdocs.yml) and theme customization
  • mcp-server/: Python MCP server implementation providing AI access to documentation
  • docs/: Shared documentation source files consumed by both components

Core Components

MCP Server (mcp-server/src/mkdocs_mcp/):

  • server.py: Main MCP server using STDIO transport, handles protocol implementation
  • resources.py: DocumentationResourceManager - converts Markdown files to MCP resources with frontmatter parsing
  • tools.py: DocumentationToolManager - provides 5 AI tools: search_docs, find_by_title, list_pages, get_page_outline, search_code_blocks

MkDocs Configuration (mkdocs-site/mkdocs.yml):

  • Material theme with dark/light mode, navigation features, and search
  • Plugins: search, minify, git-revision-date-localized, mkdocstrings (for API docs)
  • Markdown extensions: admonitions, code highlighting, Mermaid diagrams, tabbed content
  • docs_dir: ../docs points to shared documentation source

Key Architectural Decision: The MCP server reads directly from the docs/ directory to serve real-time documentation content to AI assistants via the Model Context Protocol. MkDocs builds from the same docs/ directory, ensuring both systems stay synchronized.

Common Development Commands

Essential Setup

# Initial setup (runs uv sync --dev + pre-commit install)
make setup

# Start both documentation and MCP server simultaneously  
make dev

Read the full file on GitHub · 227 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 · 227 lines · 1,953 tokens per session scan B 9e67d4685b94

Subscribe to this mod's changes

mkdocs-mcp-example CLAUDE.md is an instructions file published in the GitHub repository robmatesick/mkdocs-mcp-example (0 stars, last pushed 10mo ago), licensed MIT. It adds 1,953 tokens to every session, about $0.0078 per session on Opus 5.5. A static security scan graded it B with 1 finding (asks for root). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

mkdocs-mcp-example CLAUDE.md compared with instructions from other repositories

mkdocs-mcp-example CLAUDE.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
mkdocs-mcp-example CLAUDE.mdrobmatesick/mkdocs-mcp-exampleInstructions file010mo agoMITB1,953Claude 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