Skills

Agents Md

Creates and maintains concise AGENTS.md and CLAUDE.md project instruction files.

Install

npx skills add getsentry/skills --skill agents-md -g -a claude-code -y
Repository
getsentry/skills1.1k
Category
AI and agents
Updated
9d ago
License
Apache-2.0
Context cost
Lightabout 718 tokens
Runs scripts
No, instructions only

What it does

Creates and maintains concise AGENTS.md and CLAUDE.md project instruction files. Use when asked to create AGENTS.md, update AGENTS.md, maintain agent docs, set up CLAUDE.md, document repository agent conventions, or keep coding-agent instructions minimal and reference-backed.

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

  • Create AGENTS.md at the repository root.
  • If a Claude-compatible entrypoint is required, symlink CLAUDE.md to AGENTS.md.
  • Do not maintain divergent AGENTS.md and CLAUDE.md copies.

Default Sections

Use only sections that add non-obvious value.

# Agent Instructions

## Package Manager
- Use **pnpm**: `pnpm install`

## Commands
| Task | Command |
|------|---------|
| Test file | `pnpm vitest run path/to/file.test.ts` |
| Lint file | `pnpm eslint path/to/file.ts` |

## External References
| Need | File |
|------|------|
| Setup | `CONTRIBUTING.md` |
| Architecture | `docs/architecture.md` |
| Security policy | `SECURITY.md` |

## Key Conventions
- Generated files: update with `pnpm generate`; do not edit by hand.

## Commit Attribution
AI commits MUST include:
```
Co-Authored-By: (the agent's name and attribution byline)
```

Writing Rules

Read the whole SKILL.md on GitHub

More in AI and agents