agents-md

Installation
Summary

Create and maintain minimal, high-signal agent documentation under 60 lines.

  • Enforces research-backed best practices for agent-facing docs; instruction quality degrades with length
  • Requires three core sections: Package Manager, File-Scoped Commands (per-file test/lint/typecheck), and Commit Attribution with agent identity
  • Analyzes project structure (lock files, linter configs, CI commands, monorepo indicators) to determine what belongs in the file
  • Uses headers and bullets only; references existing docs instead of duplicating linter rules or project conventions
  • Omits obvious instructions, explanations, and filler; trusts agent capabilities and focuses on project-specific patterns
SKILL.md

Maintaining AGENTS.md

Goal: concise, actionable agent instructions. Target under 60 lines; never exceed 100.

Workflow

  1. Inspect before writing:
    • package manager: lock files and manifests
    • commands: package.json, Makefile, task runners, CI workflows
    • docs/specs/policies: README.md, CONTRIBUTING.md, docs/, specs/, policies/, SECURITY.md, .github/
    • conventions: current code patterns, test layout, generated files, legacy areas to avoid
  2. Choose scope:
    • root AGENTS.md: repo-wide defaults
    • nested AGENTS.md: only when a subtree has different commands or rules
    • closest instruction file wins; keep narrower files shorter than root files
  3. Write the smallest useful file.
  4. Verify exact paths and commands exist.

File Setup

Related skills

More from getsentry/skills

Installs
2.3K
GitHub Stars
692
First Seen
Jan 20, 2026