agentleFS
zbruhnkezbruhnke/claude-code-starter/docs/agents.md

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
  1. Distinctive:

    Add YAML frontmatter with required fields

    line 63
  2. Distinctive:

    Write instructions below the frontmatter

    line 64
  3. Very specific:

    Use sonnet for read-only agents (faster, cheaper)

    line 106
  4. Very specific:

    Use opus for agents that need deep reasoning

    line 107

≈ “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.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
agents.md

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

FieldRequiredDescription
nameYesIdentifier for the agent
descriptionYesWhen to use this agent
toolsYesComma-separated list of allowed tools
modelYessonnet (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 class

Included Agents

AgentPurposeToolsModel
researcherRead-only explorationRead, Grep, Glob, WebSearch, WebFetchsonnet
code-reviewerThorough code review with security checklistRead, Grep, Glob (read-only)opus
code-simplifierSimplify code for clarityRead, Grep, Glob, Edit, Write, Bashopus
test-writerGenerate comprehensive testsRead, Grep, Glob, Edit, Write, Bashopus
documentation-writerGenerate and update documentationRead, Grep, Glob, Edit, Writeopus
adr-writerCreate Architecture Decision RecordsRead, Grep, Glob, Writeopus

Creating Your Own Agent

  1. Create file: .claude/agents/my-agent.md
  2. Add YAML frontmatter with required fields
  3. 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

AspectSkillAgent
PurposeSpecific task with defined outputFlexible assistant for a domain
InvocationSemantic matching from descriptionExplicit "use X agent" request
ScopeSingle focused taskBroader, multi-step work
ToolsTask-specific subsetDomain-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 sonnet for read-only agents (faster, cheaper)
  • Use opus for agents that need deep reasoning
  • Be explicit about what the agent should NOT do
  • Include output format preferences in instructions

Download now (ZIP)

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
What did you use it for? e.g. Reviewing pull requests in a Rails app

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.