mcpField
S
setup-agent-md

setup-agent-md

github.com/ismail9kAgent 工作流3054 次安装1 周前更新
代码仓库

关于 setup-agent-md

setup-agent-md 是用于设置仓库根目录 Agent 指令文件的技能,以 AGENTS.md 为规范文件,并让 CLAUDE.md 指向它。技能会先检查现有文件和 Git 状态;涉及迁移或合并手写内容时,会先征求同意。

主要功能

  1. 01检查现有指令文件
  2. 02修改前查看 Git 状态
  3. 03以 AGENTS.md 作为规范指引
  4. 04将 CLAUDE.md 保留为导入指针
  5. 05迁移或合并前请求批准
  6. 06回读文件并检查最终差异

适用场景

  1. 01在仓库中设置 Agent 指令
  2. 02添加 CLAUDE.md 指针并保留 AGENTS.md
  3. 03迁移前检查相互冲突的指引

安装

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

$npx skills add https://github.com/ismail9k/skills --skill setup-agent-md

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

附带文件assets/AGENTS.mdassets/CLAUDE.md

详细介绍

设置 Agent 指令

将根目录下的 AGENTS.md 设为规范的仓库指令文件,并将根目录下的 CLAUDE.md 保留为其导入指针。本技能仅管理这两个文件;不会配置问题跟踪系统或其他特定于 Agent 的文件。

修改前先检查

  1. 找到仓库根目录,并完整阅读现有的根目录 AGENTS.md 和 CLAUDE.md。
  2. 检查 git status,避免将现有工作误认为是生成的设置内容。
  3. 写入前,概述现有内容以及将要进行的更改。

将手写内容视为有意保留的内容。用户要求快速处理,不代表可以丢弃或擅自移动这些内容。

选择安全的操作

现有状态操作
两个文件都不存在将两个资源文件原样复制到仓库根目录。
AGENTS.md 存在;CLAUDE.md 不存在保留 AGENTS.md;复制 CLAUDE.md 资源文件。
CLAUDE.md 已是导入指针保留该文件。仅在 AGENTS.md 不存在时,才根据其资源文件创建 AGENTS.md。
CLAUDE.md 包含实际指导内容展示其内容,区分通用指导和真正特定于 Claude 的指导,并询问是迁移通用部分,还是让两个文件都保持不变。
两个文件都包含实际指导内容展示重叠部分,并提议将通用指导明确合并到 AGENTS.md 中;未经用户批准不得进行更改。

合并获批后,保留用户的措辞和仓库特定结构。只补充缺失内容;不要用通用模板替换已有的 AGENTS.md。

如果获批迁移期间缺少 AGENTS.md,则以其资源文件为起始结构,并将获批的通用指导放在 Project knowledge 下。仅移除已被迁移内容取代的空占位标题。如果有任何指导必须保留为 Claude 专属内容,则在用户将其保存在这两个文件之外,或将其重新归类为通用内容之前,不得进行更改。切勿创建不完整迁移版的 AGENTS.md,导致其内容与留在 CLAUDE.md 中的指导重复。

资源文件

  • assets/AGENTS.md 是缺少 AGENTS.md 时使用的完整模板。
  • assets/CLAUDE.md 是完整的导入指针文件。

读取相关资源文件并原样复制。创建文件时,切勿凭记忆重写其中内容,除非是在执行迁移。获批的迁移可以按照上述说明,在 AGENTS.md 模板中补充保留的用户内容。该模板有意不包含问题跟踪、规划或交付工作流;之后可由其他技能添加。

完成

重新读取最终的 AGENTS.md 和 CLAUDE.md,并检查其差异。确认获批的指导既未遗漏,也未重复。随后说明哪些文件已创建、已合并、保持不变,或特意留待用户决定。完成指令文件设置后即停止,不要调用其他设置或工作流技能。

禁止事项

  • 未展示手写指令并获得明确确认前,不要覆盖或删除这些指令。
  • 不要在多个特定于 Agent 的文件中复制相同的指导。
  • 不要编辑 .cursor/、.cursorrules 或其他特定于工具的文件;它们不属于本技能的职责范围。
  • 不要创建 docs/agents/issue-tracker.md,也不要添加意向 PR 工作流。
  • 不要为模板中的空白部分臆造命令、约定、架构说明或项目事实。
  • 不要擅自替换现有的 CLAUDE.md,即使导入指针模式看起来更简洁。

评论

支持 Markdown