create-agents-md
Create AGENTS.md files for project-specific inline rules. Use when adding small, project-specific instructions that should be committed in repos.
Best use case
create-agents-md is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Create AGENTS.md files for project-specific inline rules. Use when adding small, project-specific instructions that should be committed in repos.
Teams using create-agents-md should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/create-agents-md/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How create-agents-md Compares
| Feature / Agent | create-agents-md | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Create AGENTS.md files for project-specific inline rules. Use when adding small, project-specific instructions that should be committed in repos.
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Create AGENTS.md Guide for creating AGENTS.md files for project-specific inline rules. ## When to Use AGENTS.md - **Small, project-specific instructions** that should be committed in the repo - **Folder-scoped rules** for specific directories - **Package-specific instructions** in monorepos - **Test-specific guidance** in test directories ## When NOT to Use AGENTS.md - Reusable knowledge across projects → Use skills - Large documentation → Use skills with references - Complex workflows → Use skills with scripts ## AGENTS.md Structure AGENTS.md is a simple markdown file without metadata: ```markdown # Project Instructions ## Code Style - Use TypeScript for all new files - Prefer functional components in React - Use snake_case for database columns ## Architecture - Follow the repository pattern - Keep business logic in service layers ``` ## Location - **Project root**: `AGENTS.md` – Primary, inline instructions and references for the whole project (commands, tech stack, testing, code style, architecture, safety boundaries). - **Subdirectories**: `subdirectory/AGENTS.md` – Folder- or package-scoped instructions when local behavior meaningfully diverges from the root (e.g., a specific package, service, or test tree). - **Nested support**: Agents typically combine instructions from the closest `AGENTS.md` with parent ones; keep root general and use nested `AGENTS.md` only where you truly need more specific rules. ## Best Practices - Keep AGENTS.md files small and focused - Use for project-specific conventions - Prefer **short, concrete references** over long prose: - Link to project docs, specs, and runbooks - Point to example files or directories (e.g., `see src/api/users.ts for canonical pattern`) - Include the most important commands with exact CLI invocations - Reference existing code examples when possible - Update as project evolves ## References For detailed best practices, see `references/best-practices.md`.
Related Skills
create-skill
Guide for creating effective skills following best practices. Use when creating or updating skills that extend agent capabilities.
typescript
TypeScript standards and best practices with modern tooling. Use when working with TypeScript or TypeScript React files.
software-engineer
Core software engineering principles for code style, documentation, and development workflow. Applies when editing code, working in software repositories, or performing software development tasks.
semantic-git
Manage Git commits using conventional commit format with atomic staging. Always generate plain git commands before running them and offer to let the user run them manually.
python
Python development guidelines and best practices. Use when working with Python code.
psi
Plan-spec-implement workflow for structured development. Only use when explicitly directed by user or when mentioned in project AGENTS.md file. Generates ephemeral plans in ~/.dot-agent/, applies specs to project docs, then implements test-first.
media-processing
Media processing utilities for images, audio, and video using FFmpeg and ImageMagick. Use when working with media conversion, optimization, or batch processing tasks.
frontend-engineer
Frontend development guidelines for React/TypeScript applications. Modern patterns including Suspense, lazy loading, useSuspenseQuery, file organization with features directory, MUI v7 styling, TanStack Router, performance optimization, and TypeScript best practices. Use when creating components, pages, features, fetching data, styling, routing, or working with frontend code.
context-engineering
Master context engineering for AI agent systems. Use when designing agent architectures, debugging context failures, optimizing token usage, implementing memory systems, building multi-agent coordination, evaluating agent performance, or developing LLM-powered pipelines. Covers context fundamentals, degradation patterns, optimization techniques, compression strategies, memory architectures, multi-agent patterns, evaluation, tool design, and project development.
code-review
Code review practices emphasizing technical rigor, evidence-based claims, and verification. Use when receiving code review feedback, completing tasks requiring review, or before making completion claims.
cli-building
Build command-line interfaces with async-first design, composable commands, and proper output formatting. Use when creating CLI tools, commands, or interactive terminal applications.
backend-engineer
Build robust backend systems with modern technologies (Node.js, Python, Go, Rust), frameworks (NestJS, FastAPI, Django), databases (PostgreSQL, MongoDB, Redis), APIs (REST, GraphQL, gRPC), authentication (OAuth 2.1, JWT), testing strategies, security best practices (OWASP Top 10), performance optimization, scalability patterns (microservices, caching, sharding), DevOps practices (Docker, Kubernetes, CI/CD), and monitoring. Use when designing APIs, implementing authentication, optimizing database queries, setting up CI/CD pipelines, handling security vulnerabilities, building microservices, or developing production-ready backend systems.