PlugWiki

create-agentsmd Skill for Claude: Generate an AGENTS.md for Your Repo

Makes Claude read your repository and write an AGENTS.md file with setup, test, code style and pull request instructions for coding agents.

Installs
13.2K
on skills.sh
Stars
40.7K
on GitHub
Updated
Oct 2026
last repo commit

create-agentsmd is a prompt that makes Claude write an AGENTS.md at your repository root. It tells Claude to study the project structure and scripts first, then fill sections on setup commands, development workflow, tests, code style, build and deployment, plus optional security, monorepo and pull request notes.

It follows the public guidance at agents.md, and it bundles no scripts. Its last implementation step says to test the instructions by making sure every listed command works, so Claude may run your project's commands. SKILL.md also says the closest AGENTS.md wins in a monorepo.

Good for

  • Maintainers who want coding agents to know how to build and test their repo
  • Teams standardizing agent instructions across tools
  • Monorepo owners who need per-package AGENTS.md files

Install create-agentsmd

Claude Code

  1. 1

    Copy this prompt.

    Install the create-agentsmd skill in Claude Code. Run this command:

npx skills add https://github.com/github/awesome-copilot --skill create-agentsmd

Then check that it loaded and tell me how to use it.
  2. 2

    Paste it into Claude Code. It shows the change and asks before running it.

Requires Node.js.

From its listing on skills.sh. Source.

What's in the skill

When it loads

Prompt for generating an AGENTS.md file for a repository

Sections in SKILL.md

  1. What is AGENTS.md?
  2. Key Principles
  3. File Structure and Content Guidelines
  4. 1. Required Setup
  5. 2. Essential Sections to Include
  6. 3. Optional but Recommended Sections
  7. Example Template
  8. Project Overview
  9. Setup Commands
  10. Development Workflow
  11. Testing Instructions
  12. Code Style
  13. Build and Deployment
  14. Pull Request Guidelines
  15. Additional Notes
  16. Working Example from agents.md

Key facts

Author
github organization repo awesome-copilot; the README says its customizations come from third-party developers
License
MIT
Installs on skills.sh
13,178 as of 2026-11-02
GitHub stars
40,666 for the whole repo
Last commit to the repo
2026-10-30
Files in the skill
1 file: SKILL.md
skills.sh audits
Gen Agent Trust Hub pass, Socket pass, Snyk pass

What it includes

  • Identifies languages, package managers, test frameworks and architecture.

    Step 1 of the implementation steps.

    Try: “Create an AGENTS.md for this repository.”

    Files · Analyze the project structure

  • Reads package.json scripts, Makefiles, CI configs and docs.

    Step 2. It looks for the real commands to put in the file.

    Files · Identify key workflows

  • Project overview, setup, development workflow, testing, code style, build and deploy.

    Step 3 and 4 create AGENTS.md at the repository root with exact, runnable commands.

    Write · Write the essential sections

  • Security, monorepo instructions, pull request rules, debugging.

    Added when the project needs them.

    Write · Optional sections

  • Checks that the listed commands actually work.

    Step 5 says to ensure all commands work as documented, which may mean running them.

    Runs code · Test the instructions

  • A root AGENTS.md plus one per subproject; the closest file wins.

    Includes navigation tips between packages.

    Write · Monorepo handling

From the official docs

Permissions

Low risk

The skill writes AGENTS.md and may run your project's commands to check them. Approve each command, and review the file before you commit it.

What it can do

  • Read your data
  • Create and change things
  • Delete things
  • Read-only mode

Watch out for

  • It may run your project's commands

    Step 5 says to test the instructions by ensuring the listed commands work. Approve each command, since install, build and deploy commands can change your machine or environment. github.com

Technical details
Scopes

  • Reads package.json, Makefiles, CI configuration and docs

  • Writes AGENTS.md at the repository root (and in subprojects for a monorepo)

  • May run your project's commands to test the instructions

Questions

What does the create-agentsmd skill do?

It makes Claude generate an AGENTS.md file for your repository, a "README for agents" holding setup, test, style and PR instructions, based on what it finds in your code and scripts.

How do I install create-agentsmd?

Use the install box above. The skill is one SKILL.md file with no scripts.

Does it need an API key?

No key is named in SKILL.md. It reads your repository and follows the agents.md guidance written into the prompt.

Is create-agentsmd safe?

It writes a new file at your repository root and, per its last step, may run your project's commands to check them. Review the file before you commit it. The awesome-copilot README also asks you to inspect third-party customizations before installing.

Which tools read AGENTS.md?

SKILL.md says the format works with 20+ AI coding tools, including Cursor, Aider and Gemini CLI. Check your tool's own documentation to confirm it reads the file.

What goes in the file?

Project overview, setup commands, development workflow, testing instructions, code style, and build and deployment. Optional sections cover security, monorepos, pull request guidelines and debugging.

Information

updated Nov 2, 2026

Repository
github/awesome-copilot
Folder
skills/create-agentsmd

github/awesome-copilotskills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 2
  1. SKILL.md · github.com
  2. awesome-copilot README · github.com

Updated Nov 2, 2026.