Skip to content
Get packs

Create AGENTS.md File

Generates an AGENTS.md guide so coding agents can work effectively in your repository

Source Download skill
Repository
github/awesome-copilot
Stars
40,703
Licence
MIT
Files
1 file

What it does

When installed, the agent follows a structured prompt to write an AGENTS.md file at the root of a code repository. AGENTS.md is a plain Markdown file acting as a README for AI coding tools, listing setup commands, test instructions, code style rules, and pull request conventions. The agent inspects the project (package.json, Makefiles, CI configs, docs) to fill these sections with accurate commands.

Great for

  • Maintainers who want AI coding agents to follow their project's build and test steps
  • Teams starting a new repository who want a consistent agent instruction file
  • Monorepo owners who need per-package AGENTS.md files

Skip it if

  • Projects where the agent cannot verify commands: the skill asks for commands to be tested, but generated instructions may be wrong if not checked by a human
  • Anyone expecting the file to replace README.md, since it is intended to complement human documentation

Try asking

  • “Create an AGENTS.md for this repository so coding agents know how to run tests and lint”
  • “Generate AGENTS.md with setup, testing, and PR guidelines for my Node.js monorepo”
  • “Add subproject AGENTS.md files for each package in this monorepo”
Step-by-step guide: how to use Create AGENTS.md FileInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 1 original files, the MIT licence and an attribution note.

    create-agentsmd.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip create-agentsmd.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip create-agentsmd.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Review the generated commands and run them yourself, since the skill itself says commands should be tested before they are documented
  • Keep the file focused on what agents need to know rather than general project information
  • For monorepos, ask for separate AGENTS.md files in each subproject where needed

What's inside

  • SKILL.md

Redistributed unmodified from github/awesome-copilot under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.