This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise. Guides discovery of local skills and enforces minimal documentation style.
Add this skill
npx mdskills install getsentry/agents-mdProvides clear, minimal agent documentation guidelines with skill discovery and anti-pattern warnings
1---2name: agents-md3description: This skill should be used when the user asks to "create AGENTS.md", "update AGENTS.md", "maintain agent docs", "set up CLAUDE.md", or needs to keep agent instructions concise. Guides discovery of local skills and enforces minimal documentation style.4---56# Maintaining AGENTS.md78AGENTS.md is the canonical agent-facing documentation. Keep it minimal—agents are capable and don't need hand-holding.910## File Setup11121. Create `AGENTS.md` at project root132. Create symlink: `ln -s AGENTS.md CLAUDE.md`1415## Before Writing1617Discover local skills to reference:1819```bash20find .claude/skills -name "SKILL.md" 2>/dev/null21ls plugins/*/skills/*/SKILL.md 2>/dev/null22```2324Read each skill's frontmatter to understand when to reference it.2526## Writing Rules2728- **Headers + bullets** - No paragraphs29- **Code blocks** - For commands and templates30- **Reference, don't duplicate** - Point to skills: "Use `db-migrate` skill. See `.claude/skills/db-migrate/SKILL.md`"31- **No filler** - No intros, conclusions, or pleasantries32- **Trust capabilities** - Omit obvious context33- **Skill updates** - ALWAYS use `/skill-creator` when creating or updating skills3435## Required Sections3637### Package Manager38Which tool and key commands only:39```markdown40## Package Manager41Use **pnpm**: `pnpm install`, `pnpm dev`, `pnpm test`42```4344### Commit Attribution45Always include this section. Agents should use their own identity:46```markdown47## Commit Attribution48AI commits MUST include:49```50Co-Authored-By: (the agent model's name and attribution byline)51```52Example: `Co-Authored-By: Claude Sonnet 4 <noreply@example.com>`53```5455### Key Conventions56Project-specific patterns agents must follow. Keep brief.5758### Local Skills59Reference each discovered skill:60```markdown61## Database62Use `db-migrate` skill for schema changes. See `.claude/skills/db-migrate/SKILL.md`6364## Testing65Use `write-tests` skill. See `.claude/skills/write-tests/SKILL.md`66```6768## Optional Sections6970Add only if truly needed:71- API route patterns (show template, not explanation)72- CLI commands (table format)73- File naming conventions7475## Anti-Patterns7677Omit these:78- "Welcome to..." or "This document explains..."79- "You should..." or "Remember to..."80- Content duplicated from skills (reference instead)81- Obvious instructions ("run tests", "write clean code")82- Explanations of why (just say what)83- Long prose paragraphs8485## Example Structure8687```markdown88# Agent Instructions8990## Package Manager91Use **pnpm**: `pnpm install`, `pnpm dev`9293## Commit Attribution94AI commits MUST include:95```96Co-Authored-By: (the agent model's name and attribution byline)97```9899## API Routes100[Template code block]101102## Database103Use `db-migrate` skill. See `.claude/skills/db-migrate/SKILL.md`104105## Testing106Use `write-tests` skill. See `.claude/skills/write-tests/SKILL.md`107108## CLI109| Command | Description |110|---------|-------------|111| `pnpm cli sync` | Sync data |112```113
Full transparency — inspect the skill content before installing.