Back to Skills

agents-md

Creates and maintains concise AGENTS.md and CLAUDE.md project instruction files. Use when asked to create AGENTS.md, update AGENTS.md, maintain agent docs, set up CLAUDE.md, document repository agent conventions, or keep coding-agent instructions minimal and reference-backed.

732stars38forksUpdated 5/21/2026

Security Assessment

Safe(100/100)
Security Score100/100

About agents-md

The `agents-md` skill is designed to streamline the creation and maintenance of concise AGENTS.md and CLAUDE.md files within software projects. It addresses the challenge of managing agent instructions and coding-agent workflows in repositories, ensuring that instructions remain actionable, minimal, and easy to reference. By standardizing the process of documenting agent commands and conventions, this skill prevents redundancy, reduces the risk of outdated instructions, and helps maintain clarity in collaborative environments where multiple agents or AI contributors are involved.

Key features of this skill include inspecting repository structures such as package managers, command definitions, CI workflows, and existing documentation before generating instructions. It enables users to create root-level or nested AGENTS.md files with repository-specific defaults while maintaining brevity (targeting under 60 lines). The skill supports precise path verification, structured tables for commands and external references, and integration with CLAUDE.md through symlinks when necessary. It emphasizes the inclusion of only essential sections, adherence to file-relative paths, and avoidance of duplicated content from other documentation sources. Furthermore, it enforces writing rules that prefer bullets, tables, and headings over paragraphs, maintaining a clear, reference-driven format.

Typical use cases for `agents-md` include creating initial AGENTS.md files, updating existing agent documentation, setting up CLAUDE.md entrypoints, and maintaining coding-agent instructions that are minimal yet fully reference-backed. Target users are repository maintainers, AI workflow integrators, and development teams who need to enforce consistent agent conventions across projects. This skill is particularly valuable in environments where multiple agents interact with the codebase, and precise, actionable guidance is critical for automated or semi-automated workflows.

FAQ

How do I create an AGENTS.md file using this skill?

Start by inspecting the repository for package managers, commands, documentation, and conventions. Then create a concise AGENTS.md at the root or in the relevant subtree, ensuring all paths and commands exist.

Can this skill handle CLAUDE.md integration?

Yes, if a Claude-compatible entrypoint is required, you can symlink CLAUDE.md to AGENTS.md to avoid maintaining divergent copies.

Are there limits on the size of AGENTS.md files?

Yes, the skill targets under 60 lines and enforces a maximum of 100 lines to keep instructions concise and actionable.

Does this skill duplicate existing documentation?

No, it references existing docs, specs, and policies instead of copying content, and avoids duplicating commands that are already file-scoped.

Who is the intended audience for the AGENTS.md files created with this skill?

The target audience includes repository maintainers, AI agents, and development teams who need concise, reference-backed instructions for coding-agent workflows.

All Files

3 files
SKILL.md3.1 KB
View
SOURCES.md4.2 KB
View
SPEC.md4.1 KB
View

Install agents-md

Download and extract the skill files to your .claude/skills/ directory.

Quick Setup:

  1. Copy the skill folder to .claude/skills/
  2. Claude will automatically detect and use the skill