mkdocs-ask-ai: Instructions file for Claude Code

CLAUDE.md

mkdocs-ask-ai CLAUDE.md is an instructions file for Claude Code from mrkhachaturov/mkdocs-ask-ai. It costs 540 tokens per session, scanned A, original, MIT.

A repository guide for mkdocs-ask-ai, a MkDocs plugin that prepares documentation for use with AI tools. It explains the project layout, development commands, tests, and release process.

In plain words
What is it for?
Use it when developing, testing, linting, formatting, or releasing the mkdocs-ask-ai plugin.
Why use it?
It gives an unfamiliar developer the project context needed to make safe changes without searching through the repository first.

Instructions file for Claude Code

Written for Claude Code: the file is CLAUDE.md.

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

Reuse

Borrowing it

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

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-ask-ai CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/mrkhachaturov/mkdocs-ask-ai/claude-md"><img src="https://agentmods.dev/badge/instructions/mrkhachaturov/mkdocs-ask-ai/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 540 This file is loaded in full into every session.
When invoked 540 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.00540 $0.00540
Opus 5 $0.00270 $0.00270
Sonnet 5 $0.00108 $0.00108
Haiku 4.5 $0.00054 $0.00054

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

Security

Grade A, and why

mkdocs-ask-ai 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 8d 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 · 51 lines

How it starts

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

mkdocs-ask-ai — Claude Context

What This Is

MkDocs plugin for AI-ready documentation. Published on PyPI as mkdocs-ask-ai.

Repo Structure

src/mkdocs_ask_ai/
├── __init__.py       ← version string (must stay in sync with pyproject.toml)
├── config.py         ← MkDocs plugin config options (includes deprecated copy_button_* — do NOT remove)
├── plugin.py         ← main MkDocs plugin (hooks, AI menu, llms.txt generation)
├── mcp_index.py      ← docs-index.json builder
├── mcp_server.py     ← FastMCP server (tools + resources)
└── cli.py            ← CLI entry point: `mkdocs-ask-ai mcp` starts the MCP server
tests/                ← pytest unit tests (mcp_index + mcp_server helpers)
test-site/            ← fixture MkDocs site used by CI smoke tests (not real user docs)
docs/                 ← internal design artifacts (specs, plans) — tracked in git
.artifacts/           ← local AI planning output — gitignored, never commit

Development

make install-dev      # editable install with dev + mcp extras
make check            # lint + format check + tests
make lint             # ruff check --fix
make format           # ruff format
make test             # pytest

Release

Use the /release skill — it bumps version, tags, and pushes to trigger automated PyPI publishing via GitHub Actions trusted publishing.

Key Rules

  • Version must be updated in BOTH pyproject.toml AND src/mkdocs_ask_ai/__init__.py
  • MCP SDK is an optional dependency — all mcp.* imports must stay inside the _HAS_MCP guard or inside create_server()
  • Plugin supports Python 3.9+; MCP features require 3.10+ (guarded by [mcp] extra)
  • config.py has deprecated options (enable_copy_button, copy_button_text, copy_button_position, copy_button_style) — keep them for backwards compatibility, do not remove
  • test-site/ is a CI fixture, not user-facing documentation — do not edit it as real content
  • Pre-commit hooks run ruff lint + format on every commit

Read the full file on GitHub · 51 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. 8d ago First seen · 51 lines · 540 tokens per session scan A cdc6e8fadee9

Subscribe to this mod's changes

mkdocs-ask-ai CLAUDE.md is an instructions file published in the GitHub repository mrkhachaturov/mkdocs-ask-ai (4 stars, last pushed 5mo ago), licensed MIT. It adds 540 tokens to every session, about $0.0027 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-31.

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,153 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