agentleFS
zedarvateszedarvates/botte-secrete/skills/directives_audit/SKILL.md

directives_audit

Skill2 starsChanged 3 months agoMITView on GitHub

Audit a project's AI-agent guidance files — CLAUDE.md, AGENTS.md, .cursorrules, copilot-instructions.md, GEMINI.md, intent docs and specs, in markdown, text or HTML. Use when checking whether a repo has agent instructions, whether they are healthy/consistent, or before an agent starts work on an unfamiliar codebase. Also use when the user mentions CLAUDE.md, AGENTS.md, agent rules, "does this project have instructions", or stale/oversized directive files.

The file

We split this skill into the rules it gives an agent

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before an agent works on a repo, it should know which directives exist, whether they are healthy, and — most importantly — whether they …

    line 8

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

directives_audit — validate AI-agent guidance files

Before an agent works on a repo, it should know which directives exist, whether they are healthy, and — most importantly — whether they exist at all. Inspired by shadcn/improve's "recon" step (ingest intent docs so decided tradeoffs aren't re-flagged).

When to use

  • Checking if a project has any agent instructions (CLAUDE.md / AGENTS.md / …).
  • Auditing existing directives for staleness, size, format or conflicts.
  • Onboarding to an unfamiliar repo — map its instructions, intent docs and specs.
  • The user mentions CLAUDE.md, AGENTS.md, agent rules, specs, or "directives".

Run it

python -m skills.directives_audit.cli <project_dir>          # readable report
python -m skills.directives_audit.cli <project_dir> --json   # machine-readable
from skills.directives_audit import audit
report = audit("/path/to/project")
report["has_instructions"]   # bool — the big one
report["score"]              # 0-100 directive health
report["findings"]           # severity, path, message, fix_hint

What it detects

Tool / purposeFiles
Claude CodeCLAUDE.md, CLAUDE.local.md, .claude/, .mcp.json
Codex / OpenCode / genericAGENTS.md, .agents/**
Cursor.cursorrules, .cursor/rules/**.mdc
GitHub Copilot.github/copilot-instructions.md, .github/instructions/**
Gemini / AntigravityGEMINI.md, .gemini/**
Windsurf / Cline / Roo / Aider.windsurfrules, .clinerules, .roo/**, CONVENTIONS.md
Intent (improve recon set)CONTEXT.md, DESIGN.md, PRODUCT.md, ARCHITECTURE.md, docs/adr/**
SpecsPRD.md, specs/**, spec/**

Formats: markdown, text, HTML, .mdc, json/yaml — some teams keep instructions in HTML; the audit reads HTML too and flags it as a parse-friendliness issue.

Checks

  • Missing — no instruction file anywhere → recommends creating CLAUDE.md / AGENTS.md.
  • Oversized — always-on instructions over ~2000 tok (warn) / ~5000 (err); re-sent every turn.
  • HTML instead of markdown for instruction docs.
  • Broken references — paths cited in prose docs that don't exist in the repo.
  • Empty / unreadable directive files.
  • Multiple sources — several instruction files that can drift apart.

Related: [[llm_backends]], skill_project_optimizer (per-project skill filtering).

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.