agentmd: Instructions file for Claude Code

CLAUDE.md

agentmd CLAUDE.md is an instructions file for Claude Code from mikiships/agentmd. It costs 557 tokens per session, scanned A, original, MIT.

A project guide for Claude Code, documenting the codebase, Python setup, build, test, lint, directory, naming, and commit conventions.

In plain words
What is it for?
Use it when working on the agentmd Python project, especially to install dependencies, run tests, check formatting, and follow repository conventions.
Why use it?
It gives the coding agent project-specific instructions instead of making it infer them each time.

Instructions file for Claude Code

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

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

Reuse

Borrowing it

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

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 agentmd CLAUDE.md

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

Your own site · 80×15
<a href="https://agentmods.dev/instructions/mikiships/agentmd/claude-md"><img src="https://agentmods.dev/badge/instructions/mikiships/agentmd/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 557 This file is loaded in full into every session.
When invoked 557 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.00557 $0.00557
Opus 5.5 $0.00223 $0.00223
Sonnet 5.5 $0.00111 $0.00111
Haiku 4.5 $0.00056 $0.00056

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

Security

Grade A, and why

agentmd 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 1mo 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 · 57 lines

How it starts

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

CLAUDE.md

Agent context for Claude Code. Keep this file up to date as the project evolves.

Project Overview

Primary languages: Python Package managers: pip CI: GitHub Actions

Build, Test, and Lint Commands

Install dependencies:

pip install -e '.[dev]'

Run tests:

python3 -m pytest tests/ -x

Lint / format:

ruff check . && ruff format --check .

Directory Structure

Top-level directories: .github, agentmd, tests Test roots: tests Most-changed directories: agentmd, tests, README.md, pyproject.toml, progress-log.md

Conventions Inferred from Codebase

Commit prefix style: feat, fix, chore, docs, feat(d3) (follow this pattern) Common file extensions: .pyc, .py, .md, .toml, .yml

  • Python: use type hints on all public functions
  • Python: snake_case for functions/variables, PascalCase for classes
  • Tests: files named test_*.py, functions named test_*

Claude Code Tips

  • Use /compact when context grows large mid-session to avoid token limit errors.
  • Use /review before committing to get a focused code review.
  • Use /init in a new checkout to re-read this file and orient yourself.
  • Open multiple files in a single message when changes span files — reduces round-trips.
  • Prefer small, targeted edits over full-file rewrites when touching existing code.
  • After every non-trivial change, run python3 -m pytest tests/ -x to confirm nothing broke.

Style Guide

  • All public functions and methods must have type annotations.
  • Docstrings: use triple-quoted strings on public classes and functions.
  • Maximum line length: 100 characters (unless project config says otherwise).
  • Imports: standard library first, third-party second, local last (separated by blank lines).
  • Linting enforced by ruff — run ruff check . before committing.

Anti-Patterns to Avoid

  • Do not make broad refactors outside the scope of the current task.
  • Do not delete or skip existing tests to make CI green.
  • Do not add dependencies without noting them in the commit message.
  • Do not use bare except: — always catch specific exceptions.
  • Do not use mutable default arguments (e.g., def f(x=[])).

Read the full file on GitHub · 57 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. 1mo ago First seen · 57 lines · 557 tokens per session scan A ea3cd5bbed2d

Subscribe to this mod's changes

agentmd CLAUDE.md is an instructions file published in the GitHub repository mikiships/agentmd (12 stars, last pushed 7mo ago), licensed MIT. It adds 557 tokens to every session, about $0.0022 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.

Related

Other instructions, from other repositories

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 · 9,715 tokens

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,786 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, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 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,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens