netresearch/agent-rules-skill

agent-rules

Use when creating or updating AGENTS.md files, .github/copilot-instructions.md, or other AI agent rule files, onboarding AI agents to a project, standardizing agent documentation, or when anyone mentions AGENTS.md, agent rules, project onboarding, or codeba…

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/netresearch/agent-rules-skill --skill agent-rules

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

AGENTS.md Generator Skill

Generate and maintain AGENTS.md files following the agents.md convention. AGENTS.md is FOR AGENTS, not humans.

When to Use

  • Creating or updating AGENTS.md for new/existing projects
  • Scaffolding a new repository — ship AGENTS.md with the initial commits; retrofitting later needs full re-verification
  • Standardizing agent documentation across repositories
  • Checking AGENTS.md freshness after code changes
  • Onboarding AI agents to an unfamiliar codebase

Scripts

Call every script by its full path: bash ${CLAUDE_SKILL_DIR}/scripts/<name> PATH. Calling one relative to the working directory is not covered by the frontmatter rule and raises a permission prompt per call.

ScriptPurpose
generate-agents.sh PATHGenerate AGENTS.md files
validate-structure.sh PATHValidate structure compliance
check-freshness.sh PATHCheck if files are outdated
verify-content.sh PATHVerify documented files/commands match codebase
verify-commands.sh PATHVerify documented commands execute
score-agents.sh PATHGrade AGENTS.md quality, worst-first
detect-project.sh PATHDetect language, version, build tools
detect-scopes.sh PATHIdentify directories needing scoped files
extract-commands.sh PATHExtract commands from build configs
extract-ci-rules.sh PATHExtract CI quality gates and version matrix
extract-architecture-rules.sh PATHExtract module boundaries
extract-adrs.sh PATHExtract architectural decision records
extract-github-rulesets.sh PATHExtract GitHub rulesets and merge rules

See references/scripts-guide.md for full options.

Workflow

  1. Detect: detect-project.sh + detect-scopes.sh — stacks and subsystems
  2. Extract: extract-commands.sh, extract-ci-rules.sh — gather facts
  3. Generate: generate-agents.sh --style=thin (default) or --verbose
  4. Verify: verify-content.sh + verify-commands.sh -- MANDATORY before done
  5. Line cap: before committing any root AGENTS.md edit, wc -l AGENTS.md must be under 150 (harness AH-02); run the repo's verify-harness.sh where it exists -- CI's harness check fails otherwise

--update preserves curated content outside <!-- GENERATED --> markers.

Core Principles

  • Structured over Prose -- tables parse faster than paragraphs
  • Never Fabricate -- only document what exists; verify every command and path
  • Pointer Principle -- point to files, don't duplicate content
  • Auto Symlinks -- CLAUDE.md/GEMINI.md by default (`ai-tool-compatibility.md`)

References

FileContents
`verification-guide.md`Verification steps, anti-bloat, preservation check
`fleet-sync-sweep.md`Fleet-wide AGENTS.md sweeps
`scripts-guide.md`Script options, validation checklist
`quality-rubric.md`Grading rubric
`ai-tool-compatibility.md`16-agent compatibility matrix
`output-structure.md`Root/scoped sections
`git-hooks-setup.md`Hook framework setup
`examples/`Complete examples
`ai-contribution-guidelines.md`"3 Cs" AI-contribution framework
`directory-coverage.md`Scoped-file coverage rationale
`feedback-memory-schema.md`Approved-learning file format

Templates

Root: assets/root-thin.md (default) or root-verbose.md. Scoped: assets/scoped/, one per stack (Go/PHP/Python/TYPO3/Symfony/Oro/CLI/TS/skill-repo).

Supported Projects

Go, PHP (Composer/Laravel/Symfony/TYPO3/Oro), TypeScript (React/Next/Vue/Node), Python (pip/poetry/ruff/mypy), skill repos, hybrid.

See Also

관련 작업