AGENTS.md validator
Check if your AGENTS.md, CLAUDE.md, or .cursorrules file gives coding agents the context they need to work with your product.
Last updated
What is AGENTS.md?
AGENTS.md (also known as a “skill file”) gives coding agents like GitHub Copilot, Claude Code, and Cursor direct context about your product. A well-written skill file means agents can generate correct code for your users without guessing.
Why should I add AGENTS.md to my repo?
When a coding agent works in a repo or reads docs to write code against your product, AGENTS.md is the first file it looks for. A clear skill file cuts hallucinated API calls, version drift, and support tickets - it’s onboarding documentation for AI contributors, not marketing copy. Pays for itself the first time an agent writes a customer the right code on the first try.
Where does the validator look for AGENTS.md?
- /AGENTS.md or /agents.md
- /.well-known/agents.md
- /docs/AGENTS.md
- /CLAUDE.md
- /.cursor/rules or /.cursorrules
- /llms-full.txt
What does an AGENTS.md file need to include?
Your skill file should include at least 2 of: installation instructions, configuration details, and usage examples with code blocks. These sections help agents generate correct, working code.
Minimal valid example
# Acme SDK
> TypeScript SDK for the Acme API.
## Install
```bash
npm install @acme/sdk
```
## Configure
Set `ACME_API_KEY` in your environment. Optional:
`ACME_BASE_URL` (defaults to https://api.acme.dev).
## Usage
```ts
import { Acme } from "@acme/sdk";
const client = new Acme(process.env.ACME_API_KEY);
const widgets = await client.widgets.list({ limit: 10 });
```
Write for an agent who’s seeing your product for the first time: what to install, what env vars it needs, and one code block that runs.