agentmods.dev

agent-ready CLAUDE.md

A project guide for agent-ready, a TypeScript command-line tool that checks whether a software repository is ready for development and AI-assisted work. It documents the project structure, coding rules, commands, and tests.

In plain words
What is it for?
Use it when working on this project, especially to install dependencies, run readiness checks, test, type-check, lint, format, build, or understand its MCP server.
Why use it?
It gives a coding agent the repository-specific information needed to follow conventions and run the right checks.

Instructions file

27 3mo ago A scan 519 tokens original MIT
View the source file agent-next/agent-ready
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 instructions/agent-next/agent-ready/claude-md
Clone the repo
git clone --depth 1 https://github.com/agent-next/agent-ready
Per session 519 This file is loaded in full into every session.
When invoked 519 The same file — it is already loaded in full.
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.00519 $0.00519
Opus 5 $0.00260 $0.00260
Sonnet 5 $0.00104 $0.00104
Haiku 4.5 $0.00052 $0.00052

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

Security

Grade A, and why

agent-ready 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.

CLAUDE.md · 59 lines

How it starts

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

agent-ready

Best practices collection for high-quality GitHub repos + AI coding agent workflows. TypeScript, Node 20+, Commander CLI.

Commands

npm install                    # install dependencies
npm run dev -- check .         # run CLI in dev mode
npm test                       # 102 tests, node test runner
npm run test:coverage          # coverage with c8
npm run typecheck              # tsc --noEmit
npm run lint                   # eslint
npm run format                 # prettier
npm run check                  # typecheck + lint + format (all gates)
npm run build                  # tsc → dist/

Architecture

src/index.ts (CLI entry, commander)
  → src/commands/check.ts → src/checker.ts (9-area readiness checker)
  → src/commands/init.ts (file generation)

src/checker.ts
  → src/engine/context.ts (build scan context, detect language + project type)
  → src/utils/fs.ts (fileExists, readFile, findFiles)

packages/mcp/ (MCP server, check_repo_readiness tool)

skill/agent-ready/ (SKILL.md + 8 reference docs + BDT testing refs)

Conventions

  • TypeScript strict mode, interfaces over types, avoid any
  • Files: kebab-case.ts, interfaces: PascalCase, functions: camelCase
  • Area names: agent_guidance, code_quality, testing, ci_cd, hooks, branch_rulesets, templates, devcontainer, security
  • Export all types from src/types.ts
  • Keep checks pure — no external API calls, scanning is local only

Testing

  • Runner: tsx --test (Node built-in test runner)
  • Test files mirror source: src/checker.ts → test/checker.test.ts
  • Fixtures in test/fixtures/ (minimal-repo, standard-repo, l3-repo, monorepo, python-repo, empty-repo)
  • Run tests after every change: npm test
  • Update tests in the same pass as code changes

Git

  • Atomic commits, one logical change per commit
  • Branch naming: feat/, fix/, docs/, chore/
  • PR titles: semantic prefix (feat:, fix:, docs:, etc.)
  • Run npm run check before committing

Read the full file on GitHub · 59 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. 2d ago First seen · 59 lines · 519 tokens per session scan A 1d37fb4d3fae

Subscribe to this mod's changes

agent-ready CLAUDE.md is an instructions file published in the GitHub repository agent-next/agent-ready (27 stars, last pushed 3mo ago), licensed MIT. It adds 519 tokens to every session, about $0.0026 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-30.

agentagentic-workflowai-agentsclaude-codecodexopencode
Related

Other instructions, from other repositories

deer-flow CLAUDE.md

Claude Code instructions for bytedance/deer-flow: The repo's agent guidance lives in AGENTS.md so it is shared across coding agents (Claude Code, Codex, and others). Claude Code imports it below.

bytedance/deer-flow · 50 tokens

thinkrail AGENTS.md

Instructions for JetBrains/thinkrail, covering thinkrail, module structure & boundaries (top-priority requirement), engine: pi only, in-process, architecture (three rings) and repo layout.

JetBrains/thinkrail · 4,503 tokens

sprawling AGENTS.md

Instructions for 2youg1/sprawling, covering agents.md — how work is done in this repository, the loop, read before you write, one change, five steps and the rules a machine holds.

2youg1/sprawling · 2,019 tokens

open-vibe-island CLAUDE.md

Claude Code instructions for Octane0411/open-vibe-island, covering claude.md, project, architecture, build & run and dev app (open island dev.app).

Octane0411/open-vibe-island · 1,139 tokens

codehydra CLAUDE.md

Instructions for stefanhoelzl/codehydra, covering claude.md, critical rules, no ignore comments, api/ipc interface changes and new boundary interfaces.

stefanhoelzl/codehydra · 7,616 tokens

sprawling CLAUDE.md

Instructions for 2youg1/sprawling: See AGENTS.md. It is the whole instruction set for this repository — the loop, what to read first, the five steps of one change, the rules a machine holds, and the language and commit conventions.

2youg1/sprawling · 83 tokens