skilld
All skills
getsentry avatar

/agents-md

@c190d36 official
by Sentrygetsentry/skills1k stars
53

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.

Ask your Agent

Use this Skill: https://skilld.dev/gh/getsentry/skills/agents-md

This session only. Nothing lands on disk.

SKILL.md

≈72 tokens always: the name and description. ≈718 when used: this file. ≈2.1k more on demand in 2 files.

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

  • Use headings, bullets, and tables; avoid paragraphs.
  • Use repo-relative paths; avoid vague references like "see docs".
  • Reference existing docs/specs/policies instead of copying them.
  • List exact external files for setup, architecture, API specs, security, release, and policy docs when they exist.
  • Prefer file-scoped test/lint/typecheck commands; include full builds only when no narrower command exists.
  • Put commands in tables when there is more than one.
  • Keep one rule per bullet.
  • Keep rationale out unless it prevents a likely mistake.
  • Do not restate linter, formatter, or typechecker config.
  • Do not list installed skills or plugins.
  • Do not include generic quality slogans.

External Reference Rules

Good:

## External References
| Need | File |
|------|------|
| API contract | `docs/api.md` |
| Release process | `docs/releasing.md` |

Anti-Patterns

  • welcome text, intros, conclusions, or pleasantries
  • long prose explaining why instructions matter
  • duplicated content from README.md, CONTRIBUTING.md, or policy docs
  • project-wide commands when file-scoped commands are available
  • nested AGENTS.md files that repeat root instructions

Source: SKILL.md on GitHub

Third-party checks

1 warning16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    The skill is a documentation tool designed to create and maintain concise agent instruction files (AGENTS.md and CLAUDE.md). It operates entirely as a structural guideline for text generation and contains no executable code or active scripts. A low-risk surface for indirect prompt injection exists because the skill instructs the agent to read existing repository documentation and configuration files to build its output.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    1 file scanned · No issues

  • ZeroLeaks5mo

    1 finding · Score: 69/100

Provenance

Signed by skilld at c190d36. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 5 months ago

Topics

  • Documentation
  • agents
  • claude
  • project-setup
  • instructions
  • markdown
  • repository
  • coding-agents

README badge

README badge for getsentry/skills/agents-md

What it does

Creates and maintains concise AGENTS.md and CLAUDE.md instruction files for AI coding agents. Provides a workflow for inspecting package managers, commands, docs, and conventions, then generates minimal agent instructions under 60 lines with exact paths and commands verified against the repository.

Generated from the current SKILL.md.

Frequently asked

What is the difference between AGENTS.md and CLAUDE.md?
CLAUDE.md is a Claude-compatible entrypoint that should be symlinked to AGENTS.md rather than maintained as a separate copy. The skill does not maintain divergent versions of these files.
Should I create nested AGENTS.md files in subdirectories?
Only when a subtree has different commands or rules than the root. Keep nested files shorter than the root file, and remember that the closest instruction file wins.
How long should AGENTS.md be?
Target under 60 lines; never exceed 100. The goal is concise, actionable instructions that reference external docs rather than duplicating them.
Should AGENTS.md include explanations of why instructions matter?
No. The skill avoids welcome text, intros, conclusions, and long prose. Include only rationale that prevents a likely mistake.
What should I reference in the External References section?
Link to existing files like CONTRIBUTING.md, docs/architecture.md, SECURITY.md, and API specs. Do not copy their content into AGENTS.md.

Generated from the current SKILL.md. These answers refresh after source changes.