claude-md

A skill for creating or updating the project’s `CLAUDE.md` file, which gives coding agents guidance about the project’s structure, conventions, and development commands.

In plain words
What is it for?
It helps initialize or reconcile `CLAUDE.md`, document the project at a high level, include runnable development commands, and link to existing subsystem documents.
Why use it?
It keeps agent instructions aligned with the current codebase and checks that links to subsystem documentation are valid. This reduces confusion when agents work on the project later.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/leefowlercu/agent-kit/claude-md
Any agent
npx skills add leefowlercu/agent-kit --skill claude-md
Clone the repo
git clone --depth 1 https://github.com/leefowlercu/agent-kit

Made for: Claude Code, Codex.

Per session 15 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,116 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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 $0.00015 $0.01116
Opus 5 $0.00008 $0.00558
Sonnet 5 $0.00003 $0.00223
Haiku 4.5 $0.00002 $0.00112

Measured 2d ago against content hash 154f135d2498, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

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 2d 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.

plugins/project-docs-reconciler/skills/claude-md/SKILL.md · 74 lines

How it starts

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

The project CLAUDE.md file is located at CLAUDE.md in the project root. This file provides context and instructions for Agents when working with the project.

Check if this file exists:

  • If it does not exist: Proceed to Initialization Mode
  • If it exists: Proceed to Reconciliation Mode

Shared Guidelines

When drafting or updating this documentation, you

  • MUST focus on high-level aspects of the project, ensuring it provides clear insights into architecture, conventions, and development workflows.
  • MUST NOT include low-level implementation details or exhaustive technical specifications that may change frequently during development.
  • MUST ensure that the documentation is accurate and reflects the current state of the project as understood from your analysis of the codebase.
  • MUST strike a balance between being comprehensive and concise, providing enough information to be useful without overwhelming the reader with unnecessary details.
  • MUST include actionable development commands that can be executed directly.
  • MUST validate that the subsystem documentation links are accurate and point to existing files.

Section Description Syntax: **<section-identifier>: <section-level>** { - section-title} - <section-description> { - section-example} {, section-example}...

Section Description Examples:

  • **Project Overview: H2** - A high-level description of the project's purpose and goals.
  • **Development Commands: H2** - Common commands for building, testing, and running the application.
  • **Building & Testing: H3** - Commands for building and testing the project.

The structure of the CLAUDE.md file MUST include ONLY the following sections, in order:

  1. CLAUDE.md: H1 - The literal title "CLAUDE.md".
  2. ToC: H2 - Table of Contents - A markdown table of contents that links to the subsequent header sections.
  3. Project Overview: H2 - Project Overview - A high-level description of the project's purpose, goals, and key features.
  4. Project Principles: H2 - Project Principles - Guiding principles and philosophies that inform development decisions for this project.
  5. High-Level Architecture: H2 - High-Level Architecture - An overview of the system architecture, major components, and how they interact.
  6. Subsystems Reference: H2 - Subsystems - Links and brief descriptions of subsystem documentation located in docs/subsystems/*/README.md.
  7. Conventions & Patterns: H2 - Conventions & Patterns - Code conventions, naming patterns, and stylistic choices used throughout the project.
  8. Code Organization Principles: H2 - Code Organization Principles - How code is organized within the project, including directory structure rationale.
  9. Testing Approach: H2 - Testing Approach - Testing philosophy, frameworks used, and how tests are organized.
  10. Development Commands: H2 - Development Commands - Common development commands.
    • Building & Testing: H3 - Building & Testing - Commands for building the project and running tests. Investigate package.json, Makefile, or similar build configuration files to extract these commands.
    • Running the Application: H3 - Running the Application - Commands for running the application locally and/or remotely.

Read the full file on GitHub · 74 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

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. 2d ago First seen · 74 lines · 15 tokens per session scan A 154f135d2498

Subscribe to this mod's changes

claude-md is a skill published in the GitHub repository leefowlercu/agent-kit (6 stars, last pushed 1mo ago), licensed MIT. It adds 15 tokens to every session and 1,116 once invoked, about $0.0001 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 skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens

agent-host-chat-contributions

Build and review cross-cutting agent-host chat behavior through lifecycle contributions. Use when adding turn lifecycle side effects, prompt or context injection, restored-history transformation, protocol-action observation, or when reviewing changes that add code to AgentSideEffects or AgentService.

microsoft/vscode · 56 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens