AGENTS.md
AGENTS.md — a simple, open format for guiding coding agents. Create, share, and discover agent implementations across languages and frameworks.
Why AGENTS.md?
Streamline AI agent development with standardized documentation and community-driven best practices.
Standardized Documentation
Consistent format for documenting AI agents across all projects and frameworks.
Multi-Language Support
Examples and templates for Python, TypeScript, Go, Rust, and more languages.
Quick Setup
Get started in minutes with pre-built templates and comprehensive guides.
Community Driven
Contribute and discover agent implementations from the developer community.
How to Use AGENTS.md
Get started with AI agent documentation in three simple steps.
Create Agents.md
Add an Agents.md file to your project root with agent specifications.
Document Your Agent
Describe capabilities, APIs, configuration, and usage examples.
Share & Discover
Publish your agent documentation and explore community examples.
AGENTS.md Structure
A standardized format for documenting your AI agents with all the essential information.
# Sample AGENTS.md file ## Dev environment tips - Use `pnpm dlx turbo run where <project_name>` to jump to a package instead of scanning with `ls`. - Run `pnpm install --filter <project_name>` to add the package to your workspace so Vite, ESLint, and TypeScript can see it. - Use `pnpm create vite@latest <project_name> -- --template react-ts` to spin up a new React + Vite package with TypeScript checks ready. - Check the name field inside each package's package.json to confirm the right name—skip the top-level one. ## Testing instructions - Find the CI plan in the .github/workflows folder. - Run `pnpm turbo run test --filter <project_name>` to run every check defined for that package. - From the package root you can just call `pnpm test`. The commit should pass all tests before you merge. - To focus on one step, add the Vitest pattern: `pnpm vitest run -t "<test name>"`. - Fix any test or type errors until the whole suite is green. - After moving files or changing imports, run `pnpm lint --filter <project_name>` to be sure ESLint and TypeScript rules still pass. - Add or update tests for the code you change, even if nobody asked. ## PR instructions - Title format: [<project_name>] <Title> - Always run `pnpm lint` and `pnpm test` before committing.
Frequently Asked Questions
Common questions and answers about AGENTS.md
Ready to Start Documenting?
Join the community of developers standardizing AI agent documentation.