Official agent skill

Create Agentsmd

by github in github/awesome-copilot

Prompt for generating an AGENTS.md file for a repository. An agent skill from github/awesome-copilot.

OfficialMITAuto-check passedDevelopment

Install Create Agentsmd

skills CLI
$ npx skills add github/awesome-copilot --skill create-agentsmd -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install github/awesome-copilot create-agentsmd --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/github/awesome-copilot.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/create-agentsmd .claude/skills/create-agentsmd && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
create-agentsmd
GitHub stars
40k
Used in
2 other repos
Token cost
~2k tokens
SKILL.md length
667 words
Files
1
Skills in repo
417
Repo updated
First seen
Licence
MIT

At a glance

Prompt for generating an AGENTS.md file for a repository. An agent skill from github/awesome-copilot.

  • Works in 3 steps: Required Setup → Essential Sections to Include → Optional but Recommended Sections
  • Tasks that involve Agent instruction files
  • SKILL.md covers What is AGENTS.md?, Key Principles, File Structure and Content… and Example Template, plus 5 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Create Agentsmd is an agent skill from github/awesome-copilot, published by the product's own GitHub organization. Prompt for generating an AGENTS.md file for a repository

Its SKILL.md is about 2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Agent instruction files. The repository describes itself as: Community-contributed instructions, agents, skills, and configurations to help you make the most of GitHub Copilot. The licence is MIT.

When your agent uses it

  • Tasks that involve Agent instruction files

Example prompts

  • “/create-agentsmd”

Workflow steps

3 steps, taken from the step headings in SKILL.md.

  1. Required Setup
  2. Essential Sections to Include
  3. Optional but Recommended Sections

What it can do on your machine

Read from SKILL.md and the folder at commit 727ff2e. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • agents.md

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Create Agentsmd loads about 2k tokens when it runs. Until then it costs about 18 tokens; SKILL.md has 667 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~18
When it runs · the whole SKILL.md, loaded when a task matches
~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from github/awesome-copilot at commit 727ff2e, republished under its MIT licence (© github). 667 words, ~1,964 tokens.

Download SKILL.mdSave it as .claude/skills/create-agentsmd/SKILL.md (or your agent's skills folder).
name
create-agentsmd
description
Prompt for generating an AGENTS.md file for a repository

Create high‑quality AGENTS.md file

You are a code agent. Your task is to create a complete, accurate AGENTS.md at the root of this repository that follows the public guidance at https://agents.md/.

AGENTS.md is an open format designed to provide coding agents with the context and instructions they need to work effectively on a project.

What is AGENTS.md?

AGENTS.md is a Markdown file that serves as a "README for agents" - a dedicated, predictable place to provide context and instructions to help AI coding agents work on your project. It complements README.md by containing detailed technical context that coding agents need but might clutter a human-focused README.

Key Principles

  • Agent-focused: Contains detailed technical instructions for automated tools
  • Complements README.md: Doesn't replace human documentation but adds agent-specific context
  • Standardized location: Placed at repository root (or subproject roots for monorepos)
  • Open format: Uses standard Markdown with flexible structure
  • Ecosystem compatibility: Works across 20+ different AI coding tools and agents

File Structure and Content Guidelines

1. Required Setup
  • Create the file as AGENTS.md in the repository root
  • Use standard Markdown formatting
  • No required fields - flexible structure based on project needs
2. Essential Sections to Include
Project Overview
  • Brief description of what the project does
  • Architecture overview if complex
  • Key technologies and frameworks used
Setup Commands
  • Installation instructions
  • Environment setup steps
  • Dependency management commands
  • Database setup if applicable
Development Workflow
  • How to start development server
  • Build commands
  • Watch/hot-reload setup
  • Package manager specifics (npm, pnpm, yarn, etc.)
Testing Instructions
  • How to run tests (unit, integration, e2e)
  • Test file locations and naming conventions
  • Coverage requirements
  • Specific test patterns or frameworks used
  • How to run subset of tests or focus on specific areas
Code Style Guidelines
  • Language-specific conventions
  • Linting and formatting rules
  • File organization patterns
  • Naming conventions
  • Import/export patterns
Build and Deployment
  • Build commands and outputs
  • Environment configurations
  • Deployment steps and requirements
  • CI/CD pipeline information
Security Considerations
  • Security testing requirements
  • Secrets management
  • Authentication patterns
  • Permission models
Monorepo Instructions (if applicable)
  • How to work with multiple packages
  • Cross-package dependencies
  • Selective building/testing
  • Package-specific commands
Pull Request Guidelines
  • Title format requirements
  • Required checks before submission
  • Review process
  • Commit message conventions
Debugging and Troubleshooting
  • Common issues and solutions
  • Logging patterns
  • Debug configuration
  • Performance considerations

Example Template

Use this as a starting template and customize based on the specific project:

markdown
# AGENTS.md

## Project Overview

[Brief description of the project, its purpose, and key technologies]

## Setup Commands

- Install dependencies: `[package manager] install`
- Start development server: `[command]`
- Build for production: `[command]`

## Development Workflow

- [Development server startup instructions]
- [Hot reload/watch mode information]
- [Environment variable setup]

## Testing Instructions

- Run all tests: `[command]`
- Run unit tests: `[command]`
- Run integration tests: `[command]`
- Test coverage: `[command]`
- [Specific testing patterns or requirements]

## Code Style

- [Language and framework conventions]
- [Linting rules and commands]
- [Formatting requirements]
- [File organization patterns]

## Build and Deployment

- [Build process details]
- [Output directories]
- [Environment-specific builds]
- [Deployment commands]

## Pull Request Guidelines

- Title format: [component] Brief description
- Required checks: `[lint command]`, `[test command]`
- [Review requirements]

## Additional Notes

- [Any project-specific context]
- [Common gotchas or troubleshooting tips]
- [Performance considerations]

Working Example from agents.md

Here's a real example from the agents.md website:

markdown
# Sample AGENTS.md file

## Dev environment tips

- Use `pnpm dlx turbo run where <project_name>` to jump to a package instead of scanning with `ls`.
- Run `pnpm install --filter <project_name>` to add the package to your workspace so Vite, ESLint, and TypeScript can see it.
- Use `pnpm create vite@latest <project_name> -- --template react-ts` to spin up a new React + Vite package with TypeScript checks ready.
- Check the name field inside each package's package.json to confirm the right name—skip the top-level one.

## Testing instructions

- Find the CI plan in the .github/workflows folder.
- Run `pnpm turbo run test --filter <project_name>` to run every check defined for that package.
- From the package root you can just call `pnpm test`. The commit should pass all tests before you merge.
- To focus on one step, add the Vitest pattern: `pnpm vitest run -t "<test name>"`.
- Fix any test or type errors until the whole suite is green.
- After moving files or changing imports, run `pnpm lint --filter <project_name>` to be sure ESLint and TypeScript rules still pass.
- Add or update tests for the code you change, even if nobody asked.

## PR instructions

- Title format: [<project_name>] <Title>
- Always run `pnpm lint` and `pnpm test` before committing.
Show full SKILL.md (274 more words)Show less

Implementation Steps

  1. Analyze the project structure to understand:

    • Programming languages and frameworks used
    • Package managers and build tools
    • Testing frameworks
    • Project architecture (monorepo, single package, etc.)
  2. Identify key workflows by examining:

    • package.json scripts
    • Makefile or other build files
    • CI/CD configuration files
    • Documentation files
  3. Create comprehensive sections covering:

    • All essential setup and development commands
    • Testing strategies and commands
    • Code style and conventions
    • Build and deployment processes
  4. Include specific, actionable commands that agents can execute directly

  5. Test the instructions by ensuring all commands work as documented

  6. Keep it focused on what agents need to know, not general project information

Best Practices

  • Be specific: Include exact commands, not vague descriptions
  • Use code blocks: Wrap commands in backticks for clarity
  • Include context: Explain why certain steps are needed
  • Stay current: Update as the project evolves
  • Test commands: Ensure all listed commands actually work
  • Consider nested files: For monorepos, create AGENTS.md files in subprojects as needed

Monorepo Considerations

For large monorepos:

  • Place a main AGENTS.md at the repository root
  • Create additional AGENTS.md files in subproject directories
  • The closest AGENTS.md file takes precedence for any given location
  • Include navigation tips between packages/projects

Final Notes

  • AGENTS.md works with 20+ AI coding tools including Cursor, Aider, Gemini CLI, and many others
  • The format is intentionally flexible - adapt it to your project's needs
  • Focus on actionable instructions that help agents understand and work with your codebase
  • This is living documentation - update it as your project evolves

When creating the AGENTS.md file, prioritize clarity, completeness, and actionability. The goal is to give any coding agent enough context to effectively contribute to the project without requiring additional human guidance.

© github, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/create-agentsmd of github/awesome-copilot.

Open the folder on GitHubat commit 727ff2e

Used in 2 other repositories

We found 2 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 2 other GitHub owners. This page covers the copy in github/awesome-copilot, which our catalogue first saw on October 7, 2026.

Compare with similar skills

Create Agentsmd next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Create Agentsmd compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Create Agentsmd this skillgithub/awesome-copilot40k2 repos~2kAutomated safety check: PassMIT
Warp Factory Fileswarpdotdev/warp65k1 repos~2.5kAutomated safety check: PassAGPL-3.0
Leon Coding Agentleon-ai/leon18k—~1.1kAutomated safety check: PassMIT
Mariadb Operator PR Reviewmariadb-operator/mariadb-operator1k—~3.3kAutomated safety check: PassApache-2.0
Rememberantonio-orionus/Arroxy389—~571Automated safety check: PassMIT
Code Reviewimbenrabi/Financial-Modeling-Prep-MCP-Server150—~2.6kAutomated safety check: PassApache-2.0

Similar skills

  • Warp Factory Files

    warpdotdev/warp

    Authors and edits file-based Warp software factory definitions rooted at factory.yaml, covering agents, automations, scorers and webhooks, and validates them before a pull request.

    65k GitHub starsUsed in 1 repo~2.5k tokens
    DevelopmentAuto-check passed
  • Leon Coding Agent

    leon-ai/leon

    Has Leon's agent investigate, change and verify code in a repository with its file, search and shell tools, staying inside the scope the owner authorized.

    18k GitHub stars~1.1k tokensUpdated yesterday
    DevelopmentAuto-check passed
  • Mariadb Operator PR Review

    mariadb-operator/mariadb-operator

    Perform a structured maintainer-style PR review for the mariadb-operator repository.

    1k GitHub stars~3.3k tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Remember

    antonio-orionus/Arroxy

    Persists a durable Arroxy lesson — a gotcha, user preference, workflow rule, or design decision — to the right tracked file (project memory, AGENTS.md, CONTEXT.md, dev-docs, or an ADR) so any coding…

    389 GitHub stars~571 tokensUpdated 2 days ago
    DevelopmentAuto-check passed
  • Code Review

    imbenrabi/Financial-Modeling-Prep-MCP-Server

    Review a PR or working diff against this repo's intent layer (the AGENTS.md hierarchy), toolception pitfalls, and core invariants.

    150 GitHub stars~2.6k tokensUpdated 3 mo ago
    DevelopmentAuto-check passed
  • Ss Cpp Modern

    Serial-Studio/Serial-Studio

    Modern C++20 authoring guidance for Serial Studio (Qt 6.11, C++20): concepts, ranges, move/RAII, std smart pointers, constexpr, lock-free SPSC atomics.

    7.2k GitHub stars~1.6k tokensUpdated yesterday
    DevelopmentAuto-check passed

More from github/awesome-copilot

All 417 skills in this repo
  • Acquire Codebase Knowledge

    github/awesome-copilot

    Official

    Maps an unfamiliar codebase into seven evidence-backed documents in docs/codebase/, using a scan script and templates, for onboarding or architecture write-ups.

    40k GitHub starsUsed in 1 repo~2.3k tokens
    Auto-check passed
  • Azure Architecture Autopilot

    github/awesome-copilot

    Official

    Designs Azure infrastructure from a natural-language description, or diagrams an existing resource group, then refines the design through conversation and deploys it with Bicep.

    40k GitHub starsUsed in 1 repo~1.9k tokens
    Auto-check passed
  • Draw.io Diagram Generator

    github/awesome-copilot

    Official

    Generates, edits and validates draw.io files with correct mxGraph XML, covering flowcharts, architecture, sequence, ER and UML class diagrams.

    40k GitHub starsUsed in 1 repo~4.9k tokens
    Auto-check passed
  • Credit Risk Data Cleaning

    github/awesome-copilot

    Official

    Cleans raw credit data and screens variables before loan modeling, dropping unstable, noisy or redundant features and writing an Excel report of every step.

    40k GitHub starsUsed in 1 repo~1.5k tokens
    Auto-check passed
  • Daily Focus Board

    github/awesome-copilot

    Official

    Builds a warm, browser-based daily focus board the user updates by talking to their agent, with Eisenhower priorities, a brain-dump box and kind not-today carryover.

    40k GitHub stars~3k tokensUpdated today
    Auto-check passed
  • Python Pypi Package Builder

    github/awesome-copilot

    Official

    End-to-end skill for building, testing, linting, versioning, and publishing a production-grade Python library to PyPI.

    40k GitHub starsUsed in 1 repo~4.6k tokens
    Auto-check passed

Questions about Create Agentsmd

What does Create Agentsmd do?

Prompt for generating an AGENTS.md file for a repository. An agent skill from github/awesome-copilot. Create Agentsmd is an agent skill from github/awesome-copilot, published by the product's own GitHub organization.

When should I use Create Agentsmd?

Create Agentsmd fits situations like: tasks that involve Agent instruction files.

How do I install Create Agentsmd in Claude Code?

Run `npx skills add github/awesome-copilot --skill create-agentsmd -a claude-code`. Or copy the skill folder (skills/create-agentsmd in github/awesome-copilot) into .claude/skills/create-agentsmd in your project. Claude Code loads it when a task matches its description.

How do I install Create Agentsmd in Codex?

Run `npx skills add github/awesome-copilot --skill create-agentsmd -a codex`. Or copy the skill folder (skills/create-agentsmd in github/awesome-copilot) into .agents/skills/create-agentsmd in your project. Codex loads it when a task matches its description.

Can I use Create Agentsmd in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add github/awesome-copilot --skill create-agentsmd -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/create-agentsmd, .gemini/skills/create-agentsmd, .github/skills/create-agentsmd and .opencode/skills/create-agentsmd in your project.

What does Create Agentsmd need to run?

SKILL.md names no scripts, command-line tools or credentials: Create Agentsmd is instructions for the agent only.

Does Create Agentsmd access the network?

SKILL.md names 1 domain. As links in the text: agents.md. This is read from the text; nothing was executed.

Is Create Agentsmd safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Create Agentsmd use?

Create Agentsmd is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Create Agentsmd use?

About 2k tokens (SKILL.md is roughly 7.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Create Agentsmd?

Skills that share tags, products or a category with Create Agentsmd: Warp Factory Files (warpdotdev/warp, 65k stars), Leon Coding Agent (leon-ai/leon, 18k stars), Mariadb Operator PR Review (mariadb-operator/mariadb-operator, 1k stars) and Remember (antonio-orionus/Arroxy, 389 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Create Agentsmd?

github (a GitHub organization, an official publisher) maintains it in github/awesome-copilot, which has 39,748 GitHub stars. The repository holds 417 skills in this directory. The repository was last updated on October 7, 2026.

Source: github/awesome-copilot on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.