← all repositories
agentsmd/agents.md

A README for your coding agent, since it never reads the other one

AGENTS.md proposes a simple, open markdown convention for dropping project context and instructions exactly where AI coding agents can find them.

23.5k stars TypeScript Coding Assistants
agents.md
Velocity · 7d
+21
★ / day
Trend
steady
star history

What it does

AGENTS.md is a proposed file convention: drop a markdown file named AGENTS.md in your repository and fill it with project-specific context, tooling preferences, and workflow rules. The goal is to give AI coding agents the same onboarding document humans get from a README, but structured for machine consumption. The repository itself hosts a basic Next.js website that explains the format and collects examples.

The interesting bit

The entire pitch is deliberately boring in the best way: it is just a markdown file in a predictable location, so any agent can read it without new parsers, APIs, or configuration protocols. The project bets that standardizing the location and shape of instructions is more useful than building another prompt-injection framework.

Key highlights

  • Proposes a single, discoverable AGENTS.md file as the standard place for agent instructions
  • Uses plain markdown, so no parsers, APIs, or config files to adopt
  • Ships with a reference website and concrete examples covering dev environments, testing, and PR conventions
  • Treats agent onboarding as a documentation problem rather than a framework engineering problem

Verdict

Worth adopting if you are tired of re-explaining your repo layout to an agent on every session; skip it if you were hoping for a programmable agent framework or SDK.

Frequently asked

What is agentsmd/agents.md?
AGENTS.md proposes a simple, open markdown convention for dropping project context and instructions exactly where AI coding agents can find them.
Is agents.md open source?
Yes — agentsmd/agents.md is open source, released under the MIT license.
What language is agents.md written in?
agentsmd/agents.md is primarily written in TypeScript.
How popular is agents.md?
agentsmd/agents.md has 23.5k stars on GitHub and is currently holding steady.
Where can I find agents.md?
agentsmd/agents.md is on GitHub at https://github.com/agentsmd/agents.md.

heatdrop uses Google Analytics to see which pages get read — nothing else. Your call. How we handle data.