agentleFS
jmolzjmolz/m0lz.01/.agents/skills/claude-md-improver/SKILL.md

Codex-md-improver

Skill0 starsChanged 6 months agoMITView on GitHub

Audit and improve AGENTS.md files in repositories. Use when user asks to check, audit, update, improve, or fix AGENTS.md files. Scans for all AGENTS.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "AGENTS.md maintenance" or "project memory optimization".

  • Installs packages

The file

We split this skill into the rules it gives an agent

8 rules. About 0 are common, 7 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    This skill can write to AGENTS.md files: After presenting a quality report and getting user approval, it updates AGENTS.md files with …

    line 11
  2. Distinctive:

    After outputting the quality report, ask user for confirmation before updating.

    line 97
  3. Distinctive:

    Keep it minimal: - Avoid:

    line 108
  4. Distinctive:

    After user approval, apply changes using the Edit tool.

    line 138
  5. Distinctive:

    Broken test commands: Test scripts that have changed

    line 150
  6. Distinctive:

    When presenting recommendations, remind users:

    line 155
  7. Distinctive:

    Actionable commands: All documented commands should be copy-paste ready

    line 159
  8. Very specific:

    Global defaults: Put user-wide preferences in ~/.Codex/AGENTS.md

    line 161

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 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

AGENTS.md Improver

Audit, evaluate, and improve AGENTS.md files across a codebase to ensure Codex has optimal project context.

This skill can write to AGENTS.md files. After presenting a quality report and getting user approval, it updates AGENTS.md files with targeted improvements.

Workflow

Phase 1: Discovery

Find all AGENTS.md files in the repository:

find . -name "AGENTS.md" -o -name ".AGENTS.md" -o -name ".Codex.local.md" 2>/dev/null | head -50

File Types & Locations:

TypeLocationPurpose
Project root./AGENTS.mdPrimary project context (checked into git, shared with team)
Local overrides./.Codex.local.mdPersonal/local settings (gitignored, not shared)
Global defaults~/.Codex/AGENTS.mdUser-wide defaults across all projects
Package-specific./packages/*/AGENTS.mdModule-level context in monorepos
SubdirectoryAny nested locationFeature/domain-specific context

Note: Codex auto-discovers AGENTS.md files in parent directories, making monorepo setups work automatically.

Phase 2: Quality Assessment

For each AGENTS.md file, evaluate against quality criteria. See references/quality-criteria.md for detailed rubrics.

Quick Assessment Checklist:

CriterionWeightCheck
Commands/workflows documentedHighAre build/test/deploy commands present?
Architecture clarityHighCan Codex understand the codebase structure?
Non-obvious patternsMediumAre gotchas and quirks documented?
ConcisenessMediumNo verbose explanations or obvious info?
CurrencyHighDoes it reflect current codebase state?
ActionabilityHighAre instructions executable, not vague?

Quality Scores:

  • A (90-100): Comprehensive, current, actionable
  • B (70-89): Good coverage, minor gaps
  • C (50-69): Basic info, missing key sections
  • D (30-49): Sparse or outdated
  • F (0-29): Missing or severely outdated

Phase 3: Quality Report Output

ALWAYS output the quality report BEFORE making any updates.

Format:

## AGENTS.md Quality Report

### Summary
- Files found: X
- Average score: X/100
- Files needing update: X

### File-by-File Assessment

#### 1. ./AGENTS.md (Project Root)
**Score: XX/100 (Grade: X)**

| Criterion | Score | Notes |
|-----------|-------|-------|
| Commands/workflows | X/20 | ... |
| Architecture clarity | X/20 | ... |
| Non-obvious patterns | X/15 | ... |
| Conciseness | X/15 | ... |
| Currency | X/15 | ... |
| Actionability | X/15 | ... |

**Issues:**
- [List specific problems]

**Recommended additions:**
- [List what should be added]

#### 2. ./packages/api/AGENTS.md (Package-specific)
...

Phase 4: Targeted Updates

After outputting the quality report, ask user for confirmation before updating.

Update Guidelines (Critical):

  1. Propose targeted additions only - Focus on genuinely useful info:
    • Commands or workflows discovered during analysis
    • Gotchas or non-obvious patterns found in code
    • Package relationships that weren't clear
    • Testing approaches that work
    • Configuration quirks
  2. Keep it minimal - Avoid:
    • Restating what's obvious from the code
    • Generic best practices already covered
    • One-off fixes unlikely to recur
    • Verbose explanations when a one-liner suffices
  3. Show diffs - For each change, show:
    • Which AGENTS.md file to update
    • The specific addition (as a diff or quoted block)
    • Brief explanation of why this helps future sessions

Diff Format:

### Update: ./AGENTS.md

**Why:** Build command was missing, causing confusion about how to run the project.

```diff
+ ## Quick Start
+
+ ```bash
+ npm install
+ npm run dev  # Start development server on port 3000
+ ```

### Phase 5: Apply Updates

After user approval, apply changes using the Edit tool. Preserve existing content structure.

## Templates

See [references/templates.md](references/templates.md) for AGENTS.md templates by project type.

## Common Issues to Flag

1. **Stale commands**: Build commands that no longer work
2. **Missing dependencies**: Required tools not mentioned
3. **Outdated architecture**: File structure that's changed
4. **Missing environment setup**: Required env vars or config
5. **Broken test commands**: Test scripts that have changed
6. **Undocumented gotchas**: Non-obvious patterns not captured

## User Tips to Share

When presenting recommendations, remind users:

- **`#` key shortcut**: During a Codex session, press `#` to have Codex auto-incorporate learnings into AGENTS.md
- **Keep it concise**: AGENTS.md should be human-readable; dense is better than verbose
- **Actionable commands**: All documented commands should be copy-paste ready
- **Use `.Codex.local.md`**: For personal preferences not shared with team (add to `.gitignore`)
- **Global defaults**: Put user-wide preferences in `~/.Codex/AGENTS.md`

## What Makes a Great AGENTS.md

**Key principles:**
- Concise and human-readable
- Actionable commands that can be copy-pasted
- Project-specific patterns, not generic advice
- Non-obvious gotchas and warnings

**Recommended sections** (use only what's relevant):
- Commands (build, test, dev, lint)
- Architecture (directory structure)
- Key Files (entry points, config)
- Code Style (project conventions)
- Environment (required vars, setup)
- Testing (commands, patterns)
- Gotchas (quirks, common mistakes)
- Workflow (when to do what)

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.