mcpField
A
agent-rules

agent-rules

github.com/netresearchAgent 工作流88819 次安装3 天前更新
代码仓库

关于 agent-rules

用于为 AI Agent 生成和维护 AGENTS.md 文件的 Skill，提供脚本检查仓库、记录已核实的项目约定，并验证文档准确性与时效性。它支持多种列明的语言和框架栈。

主要功能

  1. 01生成根目录及分层 AGENTS.md
  2. 02检测项目技术栈与作用范围
  3. 03提取命令和仓库规则
  4. 04验证文档内容与命令
  5. 05检查时效性并评估文件质量

适用场景

  1. 01为新仓库搭建 Agent 指引
  2. 02统一多个仓库的 Agent 文档
  3. 03代码变更后更新指引
  4. 04帮助 Agent 熟悉陌生代码库

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/netresearch/agent-rules-skill --skill agent-rules

安装后在 Claude Code 中输入/agent-rules确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

AGENTS.md
checkpoints.yaml
assets/
root-thin.md
root-verbose.md
assets/example-workflows/
validate-agents.yml
assets/scoped/
backend-go.md
backend-php.md
backend-python.md
backend-typescript.md
claude-code-skill.md
cli.md
concourse.md
ddev.md
docker.md
documentation.md
examples.md
frontend-typescript.md
github-actions.md
gitlab-ci.md
oro-bundle.md
oro-project.md
python-modern.md
resources.md
skill-repo.md
symfony.md
testing.md
typo3-docs.md
typo3-extension.md
typo3-project.md
typo3-testing.md

详细介绍

AGENTS.md 生成技能

按照 agents.md 约定生成和维护 AGENTS.md 文件。AGENTS.md 面向 AGENT，而非人类。

使用时机

  • 为新项目或现有项目创建或更新 AGENTS.md
  • 搭建新仓库——在首次提交时一并提供 AGENTS.md；之后再补充则需要重新全面验证
  • 统一各仓库中的 Agent 文档
  • 代码变更后检查 AGENTS.md 是否仍然及时
  • 帮助 AI Agent 熟悉陌生代码库

脚本

使用完整路径调用每个脚本：bash ${CLAUDE_SKILL_DIR}/scripts/<name> PATH。根据 frontmatter 规则，从工作目录使用相对路径调用脚本不在规则覆盖范围内，每次调用都会触发权限提示。

脚本用途
generate-agents.sh PATH生成 AGENTS.md 文件
validate-structure.sh PATH验证结构是否合规
check-freshness.sh PATH检查文件是否过时
verify-content.sh PATH验证文档中记录的文件和命令是否与代码库一致
verify-commands.sh PATH验证文档中记录的命令是否可以执行
score-agents.sh PATH为 AGENTS.md 质量打分，并按分数从低到高排序
detect-project.sh PATH检测语言、版本和构建工具
detect-scopes.sh PATH确定哪些目录需要专属文件
extract-commands.sh PATH从构建配置中提取命令
extract-ci-rules.sh PATH提取 CI 质量门禁和版本矩阵
extract-architecture-rules.sh PATH提取模块边界
extract-adrs.sh PATH提取架构决策记录
extract-github-rulesets.sh PATH提取 GitHub 规则集和合并规则

完整选项请参阅 references/scripts-guide.md。

工作流

  1. 检测：detect-project.sh + detect-scopes.sh——技术栈和子系统
  2. 提取：extract-commands.sh、extract-ci-rules.sh——收集事实
  3. 生成：generate-agents.sh --style=thin（默认）或 --verbose
  4. 验证：verify-content.sh + verify-commands.sh——完成前必须执行
  5. 行数上限：提交任何根目录 AGENTS.md 编辑前，wc -l AGENTS.md 的结果必须小于 150（harness AH-02）；如果仓库中存在 verify-harness.sh，请运行它——否则 CI 的 harness 检查会失败

--update 会保留 `` 标记范围之外经过整理的内容。

核心原则

  • 结构优于散文——表格比段落更容易快速解析
  • 绝不编造——只记录实际存在的内容；验证每条命令和路径
  • 指针原则——指向文件，而非复制内容
  • 自动创建符号链接——默认创建 CLAUDE.md/GEMINI.md（ai-tool-compatibility.md）

参考资料

文件内容
verification-guide.md验证步骤、避免臃肿和保留检查
fleet-sync-sweep.md全面检查所有仓库的 AGENTS.md
scripts-guide.md脚本选项和验证清单
quality-rubric.md评分标准
ai-tool-compatibility.md16 种 Agent 的兼容性矩阵
output-structure.md根目录和专属章节
git-hooks-setup.mdHook 框架设置
examples/完整示例
ai-contribution-guidelines.mdAI 贡献的“3 Cs”框架
directory-coverage.md专属文件覆盖范围说明
feedback-memory-schema.md已批准学习文件的格式

模板

根目录模板：assets/root-thin.md（默认）或 root-verbose.md。专属模板：assets/scoped/，每种技术栈一个（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

评论

支持 Markdown