agentleFS
CodeAlive-AICodeAlive-AI/ai-driven-development/skills/agentic-readiness/SKILL.md

agentic-readiness

Skill169 starsChanged 56 days agoMITView on GitHub

Audit and improve repositories for reliable agentic work across Codex and Codex App, Claude Code, and OpenCode. Use when reviewing AGENTS.md or CLAUDE.md quality and discovery, instruction routing in monorepos or meta-repos, agent settings, MCP configuration, skills, subagents, context budgets, or repository organization for coding agents.

The file

We split this skill into the rules it gives an agent

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈9

    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:

    Default to audit-only. Present findings and wait for approval unless the user explicitly asks to implement changes.

    line 8
  2. Distinctive:

    Read the repository's existing instruction chain before inspecting other files.

    line 12
  3. Distinctive:

    Run from the repository root:

    line 13
  4. Very specific:

    Add --include-user-scope only when the user explicitly wants personal Codex, Claude Code, and OpenCode configuration included.

    line 19
  5. Distinctive:

    Read the references needed for the task:

    line 22
  6. Distinctive:

    Keep the report concise:

    line 44
  7. Distinctive:

    Do not penalize a repository for omitting agent-specific configuration it does not need.

    line 53
  8. Distinctive:

    When the user asks to apply changes:

    line 57
  9. Distinctive:

    Put scoped rules near their target paths.

    line 61
  10. Distinctive:

    Keep generated directories, dependencies, caches, secondary worktrees, and unrelated subtrees out of routing tables.

    line 62

≈ “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

Agentic Readiness

Default to audit-only. Present findings and wait for approval unless the user explicitly asks to implement changes.

Audit workflow

  1. Read the repository's existing instruction chain before inspecting other files.
  2. Run from the repository root:
python scripts/audit_repo.py --root .

Add --include-user-scope only when the user explicitly wants personal Codex, Claude Code, and OpenCode configuration included. Never inspect credential stores or print secret values.

  1. Inspect the JSON report and verify findings against the actual build files, scripts, and repository layout. The script detects structural risks; it cannot prove that documented commands or architecture are current.
  2. Read the references needed for the task:
    • instruction-files.md for AGENTS.md/CLAUDE.md ownership, discovery, routing, compatibility, and CodeAlive lessons learned.
    • rubric.md for scoring and priority definitions.
    • checklist.md for the full cross-agent audit.
    • best-practices.md for settings, workflows, context, and safety beyond instruction files.
  3. Report evidence before recommendations.

Verify required commands and hooks actually work

For required build/test/lint commands and hooks, confirm they execute the intended check in the current environment. A configuration entry, hook file, or successful commit alone is not proof: a missing runner such as lefthook can leave checks unexecuted. Use a safe local invocation or an existing test fixture; do not commit, push, deploy, or perform a destructive action merely to test a hook. For a blocking hook, verify that an allowed fixture passes and a violating fixture is rejected. Confirm test commands ran the intended tests rather than finding zero or skipping them. Report what ran and its result; label anything not exercised as not verified, distinguishing it from a confirmed failure. Consider existing CI coverage when assessing the impact of a local gap.

Report shape

Keep the report concise:

  • Executive summary: readiness, strongest area, main failure mode, first action.
  • Repository profile: scale, languages/frameworks, Git/worktree shape.
  • Instruction topology: canonical file, compatibility shim, nested routing, active-chain caveats, context-budget risks.
  • Agent surfaces: Codex/Codex App, Claude Code, and OpenCode settings, MCP, skills, and subagents actually present.
  • Issues: P0 through P3 with file paths and evidence.
  • Recommendations: concrete edits and verification commands.

Do not penalize a repository for omitting agent-specific configuration it does not need. Do flag a claimed cross-agent setup that one of the named agents cannot discover.

Implementation workflow

When the user asks to apply changes:

  1. Confirm the requested scope from the conversation; do not ask again when it is already explicit.
  2. Preserve one source of truth. Prefer root AGENTS.md plus a regular CLAUDE.md containing @AGENTS.md when the same rules should serve all three agents.
  3. Put scoped rules near their target paths. Add routing indexes only where they prevent real discovery mistakes.
  4. Keep generated directories, dependencies, caches, secondary worktrees, and unrelated subtrees out of routing tables.
  5. Turn non-negotiable rules into hooks, linters, or CI checks; instruction files are guidance, not enforcement.
  6. Show the diff, rerun the audit and tests, then explain any remaining intentional gaps.

Large and multi-repository workspaces

For more than 3,000 tracked files, emphasize navigation, bounded routing, focused verification, and retrieval support rather than copying documentation into startup context.

For a directory containing multiple child Git repositories, treat each child as an independent instruction root. Codex builds its instruction chain once per run/session, so changing a command's working directory does not load the child repository's files. Recommend an explicit meta-repository routing rule and verify each child from a fresh session or by reading its chain before the first operation.

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.