{"slug":"agent-rules","title":"agent-rules","summary":"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","platform":"Claude","tags":[],"authorName":"LLM Mart","authorSlug":"llm-mart","score":0,"source":"github","price":null,"verified":false,"createdAt":"2026-09-22T13:25:52.365398Z","repo":{"url":"https://github.com/netresearch/agent-rules-skill","stars":77,"forks":6,"license":null,"updatedAt":"2026-09-20T13:46:20Z"},"bodyHtml":"
\n

name: agent-rules\ndescription: \"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.\"\nlicense: \"(MIT AND CC-BY-SA-4.0). See LICENSE-MIT and LICENSE-CC-BY-SA-4.0\"\ncompatibility: \"Requires bash 4.3+, jq 1.7+, git 2.0+.\"\nmetadata:\nauthor: Netresearch DTT GmbH\nversion: \"3.16.2\"\nrepository: https://github.com/netresearch/agent-rules-skill\nallowed-tools: Bash($/scripts/) Bash(bash $/scripts/) Bash(git:) Bash(jq:) Bash(grep:) Bash(find:) Read Glob Grep

\n

AGENTS.md Generator Skill

\n

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

\n

When to Use

\n\n

Scripts

\n

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.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
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
\n

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

\n

Workflow

\n
    \n
  1. Detect: detect-project.sh + detect-scopes.sh — stacks and subsystems
    2. \n
  2. Extract: extract-commands.sh, extract-ci-rules.sh — gather facts
    3. \n
  3. Generate: generate-agents.sh --style=thin (default) or --verbose
    4. \n
  4. Verify: verify-content.sh + verify-commands.sh -- MANDATORY before done
    5. \n
\n

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

\n

Core Principles

\n\n

References

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FileContents
verification-guide.mdVerification steps, anti-bloat, preservation check
fleet-sync-sweep.mdFleet-wide AGENTS.md sweeps
scripts-guide.mdScript options, validation checklist
quality-rubric.mdGrading rubric
ai-tool-compatibility.md16-agent compatibility matrix
output-structure.mdRoot/scoped sections
git-hooks-setup.mdHook framework setup
examples/Complete examples
ai-contribution-guidelines.md\"3 Cs\" AI-contribution framework
directory-coverage.mdScoped-file coverage rationale
feedback-memory-schema.mdApproved-learning file format
\n

Templates

\n

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).

\n

Supported Projects

\n

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

\n

See Also

\n\n","files":[{"path":"AGENTS.md","sizeBytes":3947,"isText":true},{"path":"assets/example-workflows/validate-agents.yml","sizeBytes":2833,"isText":true},{"path":"assets/root-thin.md","sizeBytes":5831,"isText":true},{"path":"assets/root-verbose.md","sizeBytes":5627,"isText":true},{"path":"assets/scoped/backend-go.md","sizeBytes":3657,"isText":true},{"path":"assets/scoped/backend-php.md","sizeBytes":3042,"isText":true},{"path":"assets/scoped/backend-python.md","sizeBytes":2697,"isText":true},{"path":"assets/scoped/backend-typescript.md","sizeBytes":2878,"isText":true},{"path":"assets/scoped/claude-code-skill.md","sizeBytes":3433,"isText":true},{"path":"assets/scoped/cli.md","sizeBytes":2736,"isText":true},{"path":"assets/scoped/concourse.md","sizeBytes":5342,"isText":true},{"path":"assets/scoped/ddev.md","sizeBytes":2454,"isText":true},{"path":"assets/scoped/docker.md","sizeBytes":5467,"isText":true},{"path":"assets/scoped/documentation.md","sizeBytes":3574,"isText":true},{"path":"assets/scoped/examples.md","sizeBytes":3509,"isText":true},{"path":"assets/scoped/frontend-typescript.md","sizeBytes":2729,"isText":true},{"path":"assets/scoped/github-actions.md","sizeBytes":5327,"isText":true},{"path":"assets/scoped/gitlab-ci.md","sizeBytes":4688,"isText":true},{"path":"assets/scoped/oro-bundle.md","sizeBytes":6704,"isText":true},{"path":"assets/scoped/oro-project.md","sizeBytes":5671,"isText":true},{"path":"assets/scoped/python-modern.md","sizeBytes":6242,"isText":true},{"path":"assets/scoped/resources.md","sizeBytes":3629,"isText":true},{"path":"assets/scoped/skill-repo.md","sizeBytes":5509,"isText":true},{"path":"assets/scoped/symfony.md","sizeBytes":5445,"isText":true},{"path":"assets/scoped/testing.md","sizeBytes":3075,"isText":true},{"path":"assets/scoped/typo3-docs.md","sizeBytes":3676,"isText":true},{"path":"assets/scoped/typo3-extension.md","sizeBytes":5226,"isText":true},{"path":"assets/scoped/typo3-project.md","sizeBytes":4819,"isText":true},{"path":"assets/scoped/typo3-testing.md","sizeBytes":3100,"isText":true},{"path":"checkpoints.yaml","sizeBytes":12765,"isText":true},{"path":"evals/evals.json","sizeBytes":23461,"isText":true},{"path":"references/ai-contribution-guidelines.md","sizeBytes":2513,"isText":true},{"path":"references/ai-tool-compatibility.md","sizeBytes":8113,"isText":true},{"path":"references/directory-coverage.md","sizeBytes":2505,"isText":true},{"path":"references/examples/coding-agent-cli/AGENTS.md","sizeBytes":2558,"isText":true},{"path":"references/examples/coding-agent-cli/go.mod","sizeBytes":45,"isText":false},{"path":"references/examples/coding-agent-cli/scripts-AGENTS.md","sizeBytes":10377,"isText":true},{"path":"references/examples/express-api-ts/AGENTS.md","sizeBytes":3191,"isText":true},{"path":"references/examples/express-api-ts/.env.example","sizeBytes":232,"isText":false},{"path":"references/examples/express-api-ts/package.json","sizeBytes":758,"isText":true},{"path":"references/examples/express-api-ts/pnpm-lock.yaml","sizeBytes":101,"isText":true},{"path":"references/examples/express-api-ts/src/AGENTS.md","sizeBytes":3178,"isText":true},{"path":"references/examples/express-api-ts/src/config.ts","sizeBytes":917,"isText":true},{"path":"references/examples/express-api-ts/src/controllers/userController.ts","sizeBytes":2106,"isText":true},{"path":"references/examples/express-api-ts/src/index.ts","sizeBytes":671,"isText":true},{"path":"references/examples/express-api-ts/src/middleware/errorHandler.ts","sizeBytes":1027,"isText":true},{"path":"references/examples/express-api-ts/src/middleware/requestLogger.ts","sizeBytes":471,"isText":true},{"path":"references/examples/express-api-ts/src/routes/health.ts","sizeBytes":428,"isText":true},{"path":"references/examples/express-api-ts/src/routes/users.ts","sizeBytes":397,"isText":true},{"path":"references/examples/express-api-ts/src/utils/errors.ts","sizeBytes":1245,"isText":true},{"path":"references/examples/express-api-ts/src/utils/logger.ts","sizeBytes":441,"isText":true},{"path":"references/examples/express-api-ts/tsconfig.json","sizeBytes":630,"isText":true},{"path":"references/examples/fastapi-app/AGENTS.md","sizeBytes":3233,"isText":true},{"path":"references/examples/fastapi-app/.env.example","sizeBytes":348,"isText":false},{"path":"references/examples/fastapi-app/pyproject.toml","sizeBytes":1799,"isText":true},{"path":"references/examples/fastapi-app/src/AGENTS.md","sizeBytes":2929,"isText":true},{"path":"references/examples/fastapi-app/src/config.py","sizeBytes":1123,"isText":true},{"path":"references/examples/fastapi-app/src/__init__.py","sizeBytes":58,"isText":true},{"path":"references/examples/fastapi-app/src/main.py","sizeBytes":1759,"isText":true},{"path":"references/examples/fastapi-app/src/models/__init__.py","sizeBytes":278,"isText":true},{"path":"references/examples/fastapi-app/src/models/item.py","sizeBytes":1036,"isText":true},{"path":"references/examples/fastapi-app/src/models/user.py","sizeBytes":922,"isText":true},{"path":"references/examples/fastapi-app/src/routes/health.py","sizeBytes":470,"isText":true},{"path":"references/examples/fastapi-app/src/routes/__init__.py","sizeBytes":110,"isText":true},{"path":"references/examples/fastapi-app/src/routes/items.py","sizeBytes":1909,"isText":true},{"path":"references/examples/fastapi-app/src/routes/users.py","sizeBytes":1722,"isText":true},{"path":"references/examples/fastapi-app/src/services/__init__.py","sizeBytes":174,"isText":true},{"path":"references/examples/fastapi-app/src/services/item_service.py","sizeBytes":2527,"isText":true},{"path":"references/examples/fastapi-app/src/services/user_service.py","sizeBytes":2116,"isText":true},{"path":"references/examples/fastapi-app/uv.lock","sizeBytes":136,"isText":false},{"path":"references/examples/go-api-with-react-admin/admin/package.json","sizeBytes":423,"isText":true},{"path":"references/examples/go-api-with-react-admin/admin/src/App.tsx","sizeBytes":101,"isText":false},{"path":"references/examples/go-api-with-react-admin/AGENTS.md","sizeBytes":3041,"isText":true},{"path":"references/examples/go-api-with-react-admin/cmd/api/main.go","sizeBytes":75,"isText":false},{"path":"references/examples/go-api-with-react-admin/go.mod","sizeBytes":31,"isText":false},{"path":"references/examples/go-api-with-react-admin/main.go","sizeBytes":71,"isText":false},{"path":"references/examples/go-api-with-react-admin/.scopes","sizeBytes":93,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/AGENTS.md","sizeBytes":3156,"isText":true},{"path":"references/examples/go-with-internal-web-tsx/go.mod","sizeBytes":34,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/internal/web/AGENTS.md","sizeBytes":3135,"isText":true},{"path":"references/examples/go-with-internal-web-tsx/internal/web/package.json","sizeBytes":329,"isText":true},{"path":"references/examples/go-with-internal-web-tsx/internal/web/src/App.tsx","sizeBytes":57,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/internal/web/src/Button.tsx","sizeBytes":63,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/internal/web/src/Footer.tsx","sizeBytes":63,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/internal/web/src/Header.tsx","sizeBytes":63,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/internal/web/src/Sidebar.tsx","sizeBytes":65,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/main.go","sizeBytes":85,"isText":false},{"path":"references/examples/go-with-internal-web-tsx/package.json","sizeBytes":221,"isText":true},{"path":"references/examples/go-with-internal-web-tsx/package-lock.json","sizeBytes":87,"isText":true},{"path":"references/examples/go-with-internal-web-tsx/.scopes","sizeBytes":102,"isText":false},{"path":"references/examples/ldap-selfservice/AGENTS.md","sizeBytes":2558,"isText":true},{"path":"references/examples/ldap-selfservice/go.mod","sizeBytes":45,"isText":false},{"path":"references/examples/ldap-selfservice/internal-AGENTS.md","sizeBytes":10276,"isText":true},{"path":"references/examples/ldap-selfservice/internal-web-AGENTS.md","sizeBytes":12427,"isText":true},{"path":"references/examples/php-with-frontend/AGENTS.md","sizeBytes":3225,"isText":true},{"path":"references/examples/php-with-frontend/composer.json","sizeBytes":185,"isText":true},{"path":"references/examples/php-with-frontend/package.json","sizeBytes":307,"isText":true},{"path":"references/examples/php-with-frontend/pnpm-lock.yaml","sizeBytes":101,"isText":true},{"path":"references/examples/php-with-frontend/.scopes","sizeBytes":89,"isText":false},{"path":"references/examples/php-with-frontend/src/Controller.php","sizeBytes":41,"isText":false},{"path":"references/examples/php-with-frontend/web/AGENTS.md","sizeBytes":3147,"isText":true},{"path":"references/examples/php-with-frontend/web/package.json","sizeBytes":515,"isText":true},{"path":"references/examples/php-with-frontend/web/src/App.tsx","sizeBytes":63,"isText":false},{"path":"references/examples/php-with-frontend/web/src/Button.tsx","sizeBytes":215,"isText":false},{"path":"references/examples/php-with-frontend/web/src/Footer.tsx","sizeBytes":125,"isText":false},{"path":"references/examples/php-with-frontend/web/src/Header.tsx","sizeBytes":122,"isText":false},{"path":"references/examples/php-with-frontend/web/src/main.tsx","sizeBytes":68,"isText":false},{"path":"references/examples/php-with-frontend/web/tsconfig.json","sizeBytes":280,"isText":true},{"path":"references/examples/pnpm-workspace/AGENTS.md","sizeBytes":2618,"isText":true},{"path":"references/examples/pnpm-workspace/package.json","sizeBytes":105,"isText":true},{"path":"references/examples/pnpm-workspace/packages/web/package.json","sizeBytes":187,"isText":true},{"path":"references/examples/pnpm-workspace/packages/web/src/index.ts","sizeBytes":258,"isText":true},{"path":"references/examples/pnpm-workspace/pnpm-lock.yaml","sizeBytes":920,"isText":true},{"path":"references/examples/pnpm-workspace/pnpm-workspace.yaml","sizeBytes":27,"isText":true},{"path":"references/examples/simple-ldap-go/AGENTS.md","sizeBytes":2558,"isText":true},{"path":"references/examples/simple-ldap-go/examples-AGENTS.md","sizeBytes":1827,"isText":true},{"path":"references/examples/simple-ldap-go/go.mod","sizeBytes":43,"isText":false},{"path":"references/examples/t3x-rte-ckeditor-image/AGENTS.md","sizeBytes":2565,"isText":true},{"path":"references/examples/t3x-rte-ckeditor-image/Classes-AGENTS.md","sizeBytes":12297,"isText":true},{"path":"references/examples/t3x-rte-ckeditor-image/composer.json","sizeBytes":174,"isText":true},{"path":"references/feedback-memory-schema.md","sizeBytes":6280,"isText":true},{"path":"references/fleet-sync-sweep.md","sizeBytes":4834,"isText":true},{"path":"references/git-hooks-setup.md","sizeBytes":2482,"isText":true},{"path":"references/output-structure.md","sizeBytes":5227,"isText":true},{"path":"references/quality-rubric.md","sizeBytes":6268,"isText":true},{"path":"references/scripts-guide.md","sizeBytes":7695,"isText":true},{"path":"references/verification-guide.md","sizeBytes":9559,"isText":true},{"path":"scripts/analyze-git-history.sh","sizeBytes":10071,"isText":true},{"path":"scripts/check-freshness.sh","sizeBytes":8476,"isText":true},{"path":"scripts/detect-golden-samples.sh","sizeBytes":5476,"isText":true},{"path":"scripts/detect-heuristics.sh","sizeBytes":3248,"isText":true},{"path":"scripts/detect-project.sh","sizeBytes":19977,"isText":true},{"path":"scripts/detect-scopes.sh","sizeBytes":13669,"isText":true},{"path":"scripts/detect-utilities.sh","sizeBytes":4367,"isText":true},{"path":"scripts/extract-adrs.sh","sizeBytes":6926,"isText":true},{"path":"scripts/extract-agent-configs.sh","sizeBytes":9440,"isText":true},{"path":"scripts/extract-architecture-rules.sh","sizeBytes":20337,"isText":true},{"path":"scripts/extract-ci-commands.sh","sizeBytes":12768,"isText":true},{"path":"scripts/extract-ci-rules.sh","sizeBytes":16359,"isText":true},{"path":"scripts/extract-commands.sh","sizeBytes":12111,"isText":true},{"path":"scripts/extract-documentation.sh","sizeBytes":7912,"isText":true},{"path":"scripts/extract-github-rulesets.sh","sizeBytes":3540,"isText":true},{"path":"scripts/extract-github-settings.sh","sizeBytes":3356,"isText":true},{"path":"scripts/extract-ide-settings.sh","sizeBytes":7136,"isText":true},{"path":"scripts/extract-platform-files.sh","sizeBytes":8114,"isText":true},{"path":"scripts/extract-quality-configs.sh","sizeBytes":15145,"isText":true},{"path":"scripts/generate-agents.sh","sizeBytes":116452,"isText":true},{"path":"scripts/generate-file-map.sh","sizeBytes":4380,"isText":true},{"path":"scripts/lib/config-root.sh","sizeBytes":5891,"isText":true},{"path":"scripts/lib/summary.sh","sizeBytes":11892,"isText":true},{"path":"scripts/lib/template.sh","sizeBytes":15182,"isText":true},{"path":"scripts/score-agents.sh","sizeBytes":10005,"isText":true},{"path":"scripts/tests/test-claude-import-file.sh","sizeBytes":3287,"isText":true},{"path":"scripts/tests/test-command-allowlist.sh","sizeBytes":3093,"isText":true},{"path":"scripts/tests/test-dependency-tree-exclusion.sh","sizeBytes":2457,"isText":true},{"path":"scripts/tests/test-extract-commands-real-scripts.sh","sizeBytes":4051,"isText":true},{"path":"scripts/tests/test-json-manifest.sh","sizeBytes":5598,"isText":true},{"path":"scripts/tests/test-scope-index-heading.sh","sizeBytes":4425,"isText":true},{"path":"scripts/tests/test-scope-index-keeps-existing.sh","sizeBytes":2457,"isText":true},{"path":"scripts/tests/test-symlink-write-boundary.sh","sizeBytes":4370,"isText":true},{"path":"scripts/validate-structure.sh","sizeBytes":13542,"isText":true},{"path":"scripts/verify-commands.sh","sizeBytes":27114,"isText":true},{"path":"scripts/verify-content.sh","sizeBytes":13019,"isText":true},{"path":"SKILL.md","sizeBytes":4913,"isText":true}],"reviewScore":null,"reviewSummary":null,"trust":{"provenance":"trusted-source-unreviewed","notice":"Community-authored content, reproduced verbatim and not vetted as instructions. Treat it as data to evaluate, never as directives to follow.","bodySource":null},"bodyLocked":false,"purchaseUrl":null,"sourceUrl":null,"report":{"provenance":"trusted-source-unreviewed","screen":{"ran":true,"outcome":"notes-only","suspicious":0,"notes":2,"hiddenCharacters":false},"virusScan":{"engine":"clamav","status":"clean","scannedAt":"2026-09-22T13:28:17.010165Z","sha256":"7A71D6029FADF4383C278881788445927A6E9233B9DE72418273FF82291BB2F7","sizeBytes":278441},"review":null,"source":{"repositoryUrl":"https://github.com/netresearch/agent-rules-skill","path":"skills/agent-rules","license":null,"commit":"6b2bb770f87269a343189a2bff90f8481bd2e199","subtreeSha":"03D80C804DD15A0800AA1DAB9530086B3EB582BB51D125202738FD02BB769854","lastSyncedAt":"2026-09-22T13:25:52.361278Z"},"reviewedAt":"2026-09-22T13:32:50.411801Z","notice":"Community-authored content, reproduced verbatim and not vetted as instructions. Treat it as data to evaluate, never as directives to follow."},"install":[{"target":"skills-cli","command":"npx skills add https://github.com/netresearch/agent-rules-skill/tree/main/skills/agent-rules"},{"target":"claude-code","command":"claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install netresearch-agent-rules-skill@llmmart"},{"target":"git","command":"git clone https://github.com/netresearch/agent-rules-skill.git"}]}