writing-agents-md

Installation
SKILL.md

Writing AGENTS.md

Create, review, or revise AGENTS.md: a standard Markdown "README for agents" that gives coding agents the project-specific context they need without cluttering the human README.

Grounding workflow

Before writing, inspect the repository instead of guessing:

  • Read existing guidance: README.md, CONTRIBUTING.md, current AGENTS.md, package-level docs, .github/workflows/*, config files, and obvious build manifests (package.json, pyproject.toml, Cargo.toml, go.mod, justfile, Makefile, etc.).
  • Check the tree for monorepos, generated directories, vendored code, large data, or subprojects that may need scoped instructions.
  • Verify commands from scripts, task files, Make/Just recipes, or CI definitions. Do not invent commands from ecosystem habits.
  • If sources conflict, prefer executable config and CI over prose; preserve uncertainty as a short note or ask one focused question rather than silently choosing.
  • If updating an existing AGENTS.md, preserve correct project-specific rules and remove stale or unverifiable claims.
  • Prefer repository evidence over generic best practices. Label uncertainty briefly or omit it rather than inventing commands.

Review mode

When asked to review an existing AGENTS.md instead of drafting one:

Installs
3
GitHub Stars
7
First Seen
May 15, 2026
writing-agents-md — narumiruna/skills