claude-code-starter
AGENTS.md16 starsChanged 10 months agoMITView on GitHub
Agents are focused AI assistants with limited tool access. They're useful for delegating specific tasks while maintaining control over what capabilities are available. Agents use YAML frontmatter followed by instructions: Invoke agents by name in your request: Use skills for repeatable tasks with consistent output (code review, test generation). Use agents for exploratory work or tasks that need judgment (research, documentation).
We split this agents.md into the rules it gives an agent
4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 63
Add YAML frontmatter with required fields
- Distinctive: line 64
Write instructions below the frontmatter
- Very specific: line 106
Use sonnet for read-only agents (faster, cheaper)
- Very specific: line 107
Use opus for agents that need deep reasoning
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Agents - Specialized Subagents
Agents are focused AI assistants with limited tool access. They're useful for delegating specific tasks while maintaining control over what capabilities are available.
Agent File Format
Agents use YAML frontmatter followed by instructions:
---
name: researcher
description: Explore and understand codebases without making changes
tools: Read, Grep, Glob, WebSearch, WebFetch
model: sonnet
---
You are a research assistant. Your job is to understand code, not change it.
When asked to research:
1. Start broad - understand the overall structure
2. Find relevant files using Grep and Glob
3. Read and understand the code
4. Explain clearly with file:line references
Never suggest changes. Only explain what exists.Available Fields
| Field | Required | Description |
name | Yes | Identifier for the agent |
description | Yes | When to use this agent |
tools | Yes | Comma-separated list of allowed tools |
model | Yes | sonnet (fast), opus (thorough), haiku (quick tasks) |
Using Agents
Invoke agents by name in your request:
Use the researcher agent to understand how authentication works
Use the code-reviewer agent to review my changes to the payment module
Use the test-writer agent to generate tests for the UserService classIncluded Agents
| Agent | Purpose | Tools | Model |
researcher | Read-only exploration | Read, Grep, Glob, WebSearch, WebFetch | sonnet |
code-reviewer | Thorough code review with security checklist | Read, Grep, Glob (read-only) | opus |
code-simplifier | Simplify code for clarity | Read, Grep, Glob, Edit, Write, Bash | opus |
test-writer | Generate comprehensive tests | Read, Grep, Glob, Edit, Write, Bash | opus |
documentation-writer | Generate and update documentation | Read, Grep, Glob, Edit, Write | opus |
adr-writer | Create Architecture Decision Records | Read, Grep, Glob, Write | opus |
Creating Your Own Agent
- Create file:
.claude/agents/my-agent.md - Add YAML frontmatter with required fields
- Write instructions below the frontmatter
Example: Documentation Agent
---
name: doc-writer
description: Generate documentation for code
tools: Read, Grep, Glob, Write
model: sonnet
---
You are a documentation specialist. When asked to document code:
1. Read the code thoroughly
2. Identify public APIs, classes, and functions
3. Generate clear, concise documentation
4. Include:
- Purpose and usage
- Parameters and return values
- Examples where helpful
- Edge cases and limitations
Write documentation in the project's existing style. If no style exists, use JSDoc/docstrings appropriate to the language.Agent vs Skill
| Aspect | Skill | Agent |
| Purpose | Specific task with defined output | Flexible assistant for a domain |
| Invocation | Semantic matching from description | Explicit "use X agent" request |
| Scope | Single focused task | Broader, multi-step work |
| Tools | Task-specific subset | Domain-appropriate subset |
Use skills for repeatable tasks with consistent output (code review, test generation).
Use agents for exploratory work or tasks that need judgment (research, documentation).
Tips
- Limit tools to only what the agent needs
- Use
sonnetfor read-only agents (faster, cheaper) - Use
opusfor agents that need deep reasoning - Be explicit about what the agent should NOT do
- Include output format preferences in instructions
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 28,693 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository12 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- changelog-writerSkill
- code-reviewSkill
- explain-codeSkill
- generate-testsSkill
- install-precommitSkill
- refactor-codeSkill
- refresh-claudeSkill
- release-checklistSkill
- review-mrSkill
- risk-registerSkill
- wiggumSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

