agent-ready AGENTS.md

Repository instructions for Agent Ready, a local command-line tool that scans projects, creates agent instruction files, checks them, and measures how prepared a repository is for coding agents.

In plain words
What is it for?
Use them when working on the Agent Ready repository, especially for its scanner, generator, linter, reports, workflows, and related command-line features.
Why use it?
They give an agent the project’s purpose, layout, runtime, and working conventions in one place. This reduces the chance of using the wrong commands or changing code inconsistently.

Instructions file for CodexOpenCode

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/eshener/agent-ready/agents-md
Clone the repo
git clone --depth 1 https://github.com/EShener/agent-ready

Made for: Codex, OpenCode.

Per session 550 This file is loaded in full into every session.
When invoked 550 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.00550 $0.00550
Opus 5 $0.00275 $0.00275
Sonnet 5 $0.00110 $0.00110
Haiku 4.5 $0.00055 $0.00055

Measured yesterday against content hash c1a52eee0d1a, 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 AGENTS.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 yesterday.

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.

AGENTS.md · 50 lines

How it starts

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

AGENTS.md

Project Overview

  • Name: agent-ready
  • Primary language: JavaScript
  • Runtime: Node.js 20+ ESM
  • Purpose: local-first CLI for scanning repositories, generating agent instruction files, linting them, and scoring agent readiness.

Repository Layout

  • bin/agent-ready.mjs: CLI executable.
  • src/scanner.mjs: repository profiling and command detection.
  • src/benchmark.mjs: multi-repository score aggregation and benchmark data.
  • src/comment.mjs: shareable PR/issue comment data generation.
  • src/compare.mjs: before/after readiness JSON comparison.
  • src/generator.mjs: AGENTS.md and tool-specific shim generation.
  • src/linter.mjs: readiness rules and scoring inputs.
  • src/matrix.mjs: AI coding agent compatibility matrix generation.
  • src/reporter.mjs: text, JSON, and Markdown output rendering.
  • src/config.mjs: optional agent-ready.json loading and validation.
  • src/explainer.mjs: impact-ranked fix plan data for explain.
  • src/interactive.mjs: guided setup prompts for init --interactive.
  • src/workflow.mjs: GitHub Actions workflow generation and write-mode support.
  • scripts/benchmark-sample.mjs: optional public repository benchmark runner.
  • test/: Node test suite and repository fixtures.

Commands

  • install: npm install
  • test: npm test
  • lint: npm run lint
  • check: npm run check

Agent Workflow

  • Read this file and README.md before editing.
  • Keep the CLI zero-dependency unless there is a strong reason to add a package.
  • Preserve deterministic output for tests and fixture snapshots.
  • Prefer small rule additions over broad rewrites of scanner behavior.

Safety Boundaries

  • Do not modify generated dependency folders such as node_modules, coverage, dist, or build.
  • Do not rewrite unrelated files or revert user changes.
  • Do not add network calls, telemetry, or API-key requirements to the default path.
  • Ask before publishing, tagging, deleting files, or changing package ownership metadata.

Read the full file on GitHub · 50 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. yesterday First seen · 50 lines · 550 tokens per session scan A c1a52eee0d1a

Subscribe to this mod's changes

agent-ready AGENTS.md is an instructions file published in the GitHub repository EShener/agent-ready (1 stars, last pushed 2mo ago), licensed MIT. It adds 550 tokens to every session, about $0.0028 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 instructions, from other repositories

memorix CLAUDE.md

Instructions for AVIDS2/memorix, covering memorix - agent instructions for claude code, using memorix memory tools, when to search memory, when to store memory and when to resolve memory.

AVIDS2/memorix · 1,073 tokens

rosetta AGENTS.md

Instructions for griddynamics/rosetta: Main goal: cover E2E AI PDLC engineering workflows at foundation level for AI-First SDLC in enterprise. Top-level or orchestrator agents MUST READ docs/ARCHITECTURE.md contains technical details and guidance, and docs/CONTEXT.md - business context. Subagents - when needed.…

griddynamics/rosetta · 270 tokens

inspecto CLAUDE.md

Instructions for inspecto-dev/inspecto, covering inspecto — claude code development guide, project overview, monorepo structure, development phases (load each file as needed) and key architectural decisions.

inspecto-dev/inspecto · 1,014 tokens

specops CLAUDE.md

Instructions for sanmak/specops, covering claude.md, what is specops, build & validate commands, run all tests (single command) and generate for a single platform.

sanmak/specops · 1,576 tokens

clawd-on-desk AGENTS.md

AGENTS.md instructions for rullerzhou-afk/clawd-on-desk, covering agents.md, project overview, common commands, read these docs and runtime summary.

rullerzhou-afk/clawd-on-desk · 10,139 tokens

mcp-unity AGENTS.md

Instructions for CoderGamester/mcp-unity, covering mcp unity — ai agent guide (mcp package), purpose (what this repo is), how it works (high-level data flow), key defaults & invariants and repo layout (where to change what).

CoderGamester/mcp-unity · 2,498 tokens