agents-md
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.
Security Assessment
About agents-md
The 'agents-md' skill serves as a streamlined documentation tool for agents, focusing on the creation and maintenance of the AGENTS.md file. It addresses the need for concise, agent-facing documentation by emphasizing a minimalistic style that avoids unnecessary explanations and filler content. This skill is particularly useful for developers who need to ensure that their agent instructions are clear, direct, and easily accessible without extensive background information.
FAQ
How do I create an AGENTS.md file?
Create the AGENTS.md file at the project root and create a symlink to CLAUDE.md using 'ln -s AGENTS.md CLAUDE.md'.
What writing style should I follow for AGENTS.md?
Use headers and bullet points without paragraphs, include code blocks for commands, and avoid filler content.
Are there any required sections in AGENTS.md?
Yes, required sections include Package Manager and Commit Attribution.
Can I include explanations in AGENTS.md?
No, the style guide advises against including explanations, filler text, or obvious instructions.
What local skills should I reference in AGENTS.md?
Reference each discovered skill by pointing to their respective SKILL.md files.
Install agents-md
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
getsentry/skills