agent-ready AGENTS.md

agent-ready AGENTS.md is an instructions file for Codex, OpenCode from vb-nattamai/agent-ready. It costs 2,930 tokens per session, scanned A, original, MIT.

A project instruction file for AgentReady, a Python tool that examines an existing code repository and creates files that help AI agents understand and work on it.

In plain words
What is it for?
Use it when developing, testing, installing, or extending AgentReady and its generated agent guidance files.
Why use it?
It gives agents verified project context, required commands, and operating rules instead of making them guess how the repository works.

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

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for agent-ready AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/vb-nattamai/agent-ready/agents-md.svg)](https://agentmods.dev/instructions/vb-nattamai/agent-ready/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/vb-nattamai/agent-ready/agents-md"><img src="https://agentmods.dev/badge/instructions/vb-nattamai/agent-ready/agents-md.svg" alt="Measured on agentmods" height="20"></a>
Per session 2,930 This file is loaded in full into every session.
When invoked 2,930 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.02930 $0.02930
Opus 5 $0.01465 $0.01465
Sonnet 5 $0.00586 $0.00586
Haiku 4.5 $0.00293 $0.00293

Measured 5d ago against content hash 015b3348d1af, 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 5d 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.

AGENTS.md · 200 lines

How it starts

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

AGENTS.md — AgentReady Operating Contract

This file is the authoritative operating contract for GitHub Copilot, OpenAI agents, and any other AI agent working in this repository. Read it completely before taking any action.


Project Overview

Project: agent-ready Language: Python 3 (single-package, src/ layout) Build tool: pip / setuptools with dynamic version reading Key runtime dependency: litellm (optional — only available when installed with the [ai] extra) Linter/Formatter: ruff Test framework: pytest with pytest-cov

AgentReady transforms any legacy repository into an AI-agent-ready codebase by running a 5-phase pipeline that reads actual source code, sends it to an LLM for structured analysis, and then generates scaffolding files (AGENTS.md, CLAUDE.md, system_prompt.md, agent-context.json, memory/schema.md) that give AI agents verified, grounded knowledge of that repository. It is provider-agnostic via LiteLLM, supporting Anthropic, OpenAI, Google, Groq, Mistral, Together, and Ollama. The CLI entry point is src/agent_ready/cli.py; the agent-ready command is installed by pip install.


Commands

These are the exact, verified commands for this repository. Use them verbatim.

Install (development)

pip install -e '.[dev]'

Install (end-user, with LLM support)

pip install "git+https://github.com/vb-nattamai/agent-ready.git[ai]"

Run

agent-ready --target /path/to/repo

Run (dry-run — preview without writing any files)

agent-ready --target /path/to/repo --dry-run

Run (evaluate existing context files without regenerating)

agent-ready --target /path/to/repo --eval-only

Test (with coverage enforcement)

pytest -q --cov=src/agent_ready --cov-report=term-missing --cov-fail-under=50

Read the full file on GitHub · 200 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. 5d ago First seen · 200 lines · 2,930 tokens per session scan A 015b3348d1af

Subscribe to this mod's changes

agent-ready AGENTS.md is an instructions file published in the GitHub repository vb-nattamai/agent-ready (5 stars, last pushed 1mo ago), licensed MIT. It adds 2,930 tokens to every session, about $0.0146 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.