agentmd: Instructions file for Codex

AGENTS.md

agentmd AGENTS.md is an instructions file for Codex, OpenCode from mikiships/agentmd. It costs 642 tokens per session, scanned A, original, MIT.

Repository instructions for a Python project called agentmd. They document how to install it, run tests and code checks, understand its folders, and work within a restricted coding sandbox.

In plain words
What is it for?
Installing development dependencies, running pytest and Ruff checks, finding the main source and test folders, and writing tests that mock external requests.
Why use it?
They provide the project rules and commands an agent needs, helping it test changes correctly and avoid relying on unavailable network access or system tools.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: mentions AGENTS.md; mentions Codex.

This is mikiships/agentmd's own configuration. It tells Codex and OpenCode how to work on agentmd itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything agentmd configures →

Reuse

Borrowing it

Nothing to install: this file belongs to mikiships/agentmd. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/mikiships/agentmd/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/mikiships/agentmd

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 agentmd AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/mikiships/agentmd/agents-md/github.svg)](https://agentmods.dev/instructions/mikiships/agentmd/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/mikiships/agentmd/agents-md"><img src="https://agentmods.dev/badge/instructions/mikiships/agentmd/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for agentmd AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/mikiships/agentmd/agents-md"><img src="https://agentmods.dev/badge/instructions/mikiships/agentmd/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 642 This file is loaded in full into every session.
When invoked 642 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00642 $0.00642
Opus 5.5 $0.00257 $0.00257
Sonnet 5.5 $0.00128 $0.00128
Haiku 4.5 $0.00064 $0.00064

Measured 1mo ago against content hash f1a5868ae375, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

agentmd 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 1mo 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 · 64 lines

How it starts

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

AGENTS.md

Agent context for OpenAI Codex. This file is read automatically by the Codex sandbox at session start.

Project Overview

Primary languages: Python Package managers: pip CI: GitHub Actions

Build, Test, and Lint Commands

Install dependencies:

pip install -e '.[dev]'

Run tests:

python3 -m pytest tests/ -x

Lint / format:

ruff check . && ruff format --check .

Directory Structure

Top-level directories: .github, agentmd, tests Test roots: tests Most-changed directories: agentmd, tests, README.md, pyproject.toml, progress-log.md

Sandbox Awareness

The Codex sandbox has network access disabled by default during code execution.

  • Do not make HTTP requests in tests — mock all external calls.
  • Do not rely on system-installed tools; prefer project-local binaries (./node_modules/.bin/, virtualenv, etc.).
  • The sandbox resets between sessions — do not rely on persistent state outside the repo.
  • Python dependencies: install into a virtualenv. The sandbox may not have all packages pre-installed.

Conventions Inferred from Codebase

Commit prefix style: feat, fix, chore, docs, feat(d3) (follow this pattern) Common file extensions: .pyc, .py, .md, .toml, .yml

  • Python: use type hints on all public functions
  • Python: snake_case for functions/variables, PascalCase for classes
  • Tests: files named test_*.py, functions named test_*

apply_patch Usage

When modifying files, prefer apply_patch over full-file writes for surgical changes:

  • Keep patches small and focused on the minimal diff.
  • After applying a patch, run the test command to verify correctness.
  • Use apply_patch with create action for new files, modify for existing ones.
  • For large structural refactors, consider writing the full new file instead of a complex patch.

Approval Gates

Before marking a task complete, verify ALL of the following:

  • Tests pass: python3 -m pytest tests/ -x
  • Linting clean: ruff check . && ruff format --check .
  • No unintended files modified (check git diff --stat)
  • New code has corresponding tests (if behavior change)
  • Commit message follows the project prefix convention

Read the full file on GitHub · 64 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. 1mo ago First seen · 64 lines · 642 tokens per session scan A f1a5868ae375

Subscribe to this mod's changes

agentmd AGENTS.md is an instructions file published in the GitHub repository mikiships/agentmd (12 stars, last pushed 7mo ago), licensed MIT. It adds 642 tokens to every session, about $0.0026 per session on Opus 5.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.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,786 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,731 tokens

deno copilot-instructions.md

Copilot instructions for denoland/deno, covering deno development guide for github copilot, network access, high level overview, key directories and key files to understand first.

denoland/deno · 3,077 tokens