// 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.
Prepares Go applications to work effectively with AI coding agents. Use when setting up a new Go project or retrofitting an existing one to ensure: structured JSON logging (slog/Zap/ZeroLog/Logrus), machine-readable command output, thorough golangci-lint configuration, non-interactive CLI design with --yes flags, structured error handling with meaningful exit codes, proper context.Context propagation, graceful shutdown, health check endpoints, and a standardized Makefile. Triggers when a user asks to make their Go app "agent-ready," "AI-friendly," wants to improve agent tooling/observability in a Go project, or needs to audit an existing Go project against agent-readiness best practices.
Validate commit messages against the Conventional Commits specification. Auto-detects and installs commitlint CLI if missing. Checks project config or falls back to sensible defaults. Use when validating commit messages, preparing PRs, or enforcing commit conventions.
Audit Go nolint directives for staleness and lazy justifications. Mechanically verifies each suppression with golangci-lint, then runs adversarial Red/Blue/White debates on the top candidates for removal. Use when inheriting a Go codebase, during periodic cleanup, or when nolint count is growing unchecked.
Validate markdown files against formatting standards. Auto-detects and installs markdownlint-cli if missing. Checks project config or falls back to sensible defaults. Supports auto-fix mode. Use when creating or modifying markdown files, validating documentation, or enforcing markdown conventions.
Generate a PR_MESSAGE.md file from session context using GitHub CLI. Detects related issues via branch-keyword search, writes a structured PR description with commit subject, summary, test plan, and changelog. Validates with commitlint and markdownlint. Use when preparing a pull request on GitHub.
Strategic roadmap management for GitHub repositories. Syncs ROADMAP.md with GitHub Issues and labels, bootstraps roadmap files from scratch, runs brainstorming sessions with boundary checking, and provides quick status summaries. Use when managing project planning, syncing roadmap state, or exploring feature ideas.
| name | agent-rules |
| description | 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. |
| license | (MIT AND CC-BY-SA-4.0). See LICENSE-MIT and LICENSE-CC-BY-SA-4.0 |
| compatibility | Requires bash 4.3+, jq 1.5+, git 2.0+. |
| metadata | {"author":"Netresearch DTT GmbH","version":"3.11.0","repository":"https://github.com/netresearch/agent-rules-skill"} |
| allowed-tools | Bash(git:*) Bash(jq:*) Bash(grep:*) Bash(find:*) Bash(bash:*) Read Glob Grep |
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).