skills/agent-rules/SKILL.md
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 codebase documentation for AI agents.
npx skillsauth add netresearch/agent-rules-skill agent-rulesInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Generate and maintain AGENTS.md files following the agents.md convention. AGENTS.md is FOR AGENTS, not humans.
| Script | Purpose |
|--------|---------|
| scripts/generate-agents.sh PATH | Generate AGENTS.md files |
| scripts/validate-structure.sh PATH | Validate structure compliance |
| scripts/check-freshness.sh PATH | Check if files are outdated |
| scripts/verify-content.sh PATH | Verify documented files/commands match codebase |
| scripts/verify-commands.sh PATH | Verify documented commands execute |
| scripts/detect-project.sh PATH | Detect language, version, build tools |
| scripts/detect-scopes.sh PATH | Identify directories needing scoped files |
| scripts/extract-commands.sh PATH | Extract commands from build configs |
| scripts/extract-ci-rules.sh PATH | Extract CI quality gates and version matrix |
| scripts/extract-architecture-rules.sh PATH | Extract module boundaries |
| scripts/extract-adrs.sh PATH | Extract architectural decision records |
| scripts/extract-github-rulesets.sh PATH | Extract GitHub rulesets and merge rules |
See references/scripts-guide.md for full options.
detect-project.sh + detect-scopes.sh to identify stacks and subsystemsextract-commands.sh, extract-ci-rules.sh, etc. to gather factsgenerate-agents.sh with --style=thin (default) or --verboseverify-content.sh + verify-commands.sh -- MANDATORY before doneUse --update to preserve human-curated content outside <!-- GENERATED --> markers.
ai-tool-compatibility.md)| File | Contents |
|------|----------|
| verification-guide.md | Verification steps, design principles |
| scripts-guide.md | Script options, validation checklist |
| ai-tool-compatibility.md | 16-agent compatibility matrix |
| output-structure.md | Root/scoped sections |
| git-hooks-setup.md | Hook framework detection and setup |
| examples/ | Complete examples |
| ai-contribution-guidelines.md | "3 Cs" framework for AI contributions (Comprehension, Context, Continuity) |
| directory-coverage.md | Full coverage rationale for scoped AGENTS.md files |
Root: assets/root-thin.md (default), root-verbose.md. Scoped: assets/scoped/ -- backend-go.md, backend-php.md, python-modern.md, typo3.md, symfony.md, skill-repo.md, cli.md, frontend-typescript.md, oro.md.
Go, PHP (Composer/Laravel/Symfony/TYPO3/Oro), TypeScript (React/Next/Vue/Node), Python (pip/poetry/ruff/mypy), Skill repos, Hybrid (multi-stack with auto-scoping).
agent-harness-skill — broader agent-readiness harness (CI verification, enforcement). Invokes this skill when AGENTS.md is missing.skill-repo-skill — skill-repo structure (plugin.json, split licensing, release workflows).development
Maintainer-only workflow for handling GitHub Secret Scanning alerts on OpenClaw. Use when Codex needs to triage, redact, clean up, and resolve secret leakage found in issue comments, issue bodies, PR comments, or other GitHub content.
development
Maintainer workflow for OpenClaw releases, prereleases, changelog release notes, and publish validation. Use when Codex needs to prepare or verify stable or beta release steps, align version naming, assemble release notes, check release auth requirements, or validate publish-time commands and artifacts.
development
Run, watch, debug, and extend OpenClaw QA testing with qa-lab and qa-channel. Use when Codex needs to execute the repo-backed QA suite, inspect live QA artifacts, debug failing scenarios, add new QA scenarios, or explain the OpenClaw QA workflow. Prefer the live OpenAI lane with regular openai/gpt-5.4 in fast mode; do not use gpt-5.4-pro or gpt-5.4-mini unless the user explicitly overrides that policy.
development
End-to-end Parallels smoke, upgrade, and rerun workflow for OpenClaw across macOS, Windows, and Linux guests. Use when Codex needs to run, rerun, debug, or interpret VM-based install, onboarding, gateway smoke tests, latest-release-to-main upgrade checks, fresh snapshot retests, or optional Discord roundtrip verification under Parallels.