---
title: AGENTS.md Validator
description: Check if your AGENTS.md, CLAUDE.md, or .cursorrules file gives coding agents the context they need to work with your product.
last_updated: 2026-05-11
canonical_url: https://agent-ready.dev/agents-md-validator
---

# 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.

## What is AGENTS.md?

AGENTS.md (also known as a "skill file") gives coding agents like GitHub Copilot, Claude Code, Codex, Aider, 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

```markdown
# Acme SDK

> TypeScript SDK for the Acme API.

## Install

\`\`\`bash
npm install @acme/sdk
\`\`\`

## Configure

Set \`ACME_API_KEY\` in your environment.

## 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.

## Reference

- [agents.md](https://agents.md) — community convention (not a formal standard)
- [Claude Code memory (CLAUDE.md) — Anthropic docs](https://code.claude.com/docs/en/memory)
- [Cursor rules (.cursorrules) — Cursor docs](https://cursor.com/docs/rules)

---

Validate your skill file: <https://agent-ready.dev/agents-md-validator>

Related guides:

- [How to write an effective AGENTS.md](https://agent-ready.dev/how-to-write-an-effective-agents-md)
- [AGENTS.md vs CLAUDE.md vs .cursorrules](https://agent-ready.dev/agents-md-vs-claude-md-vs-cursorrules)

## Sitemap

See the full [sitemap](https://agent-ready.dev/sitemap.md) for all pages on agent-ready.dev.