mcpField
A
agent-instruction

agent-instruction

github.com/validkeysAgent 工作流050 次安装28 周前更新
代码仓库

关于 agent-instruction

agent-instruction 是用于在开发过程中管理 monorepo 中 AI 指令文件的 Skill，依赖已安装的 agent-instruction CLI。它可维护规则，并据此生成或更新 CLAUDE.md 和 AGENTS.md。

主要功能

  1. 01添加指令规则
  2. 02构建或更新指令文件
  3. 03列出规则及其内容
  4. 04按类别组织规则文件

适用场景

  1. 01将反复出现的开发规范保存为规则
  2. 02检查现有规则以避免重复
  3. 03把规则配置同步到 CLAUDE.md 和 AGENTS.md

安装

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

$npx skills add https://github.com/validkeys/agent-instruction --skill agent-instruction

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

详细介绍

agent-instruction

在开发过程中管理单体仓库中的 AI 指令文件。此技能可弥合在开发过程中发现最佳实践与将其编写为持久指令之间的差距。

使用 agent-instruction CLI 添加规则、构建指令文件并列出现有规则。

需要： 已安装 agent-instruction CLI，且可在 PATH 中访问（go install github.com/validkeys/agent-instruction@latest）

命令

add_rule

向规则文件添加新指令规则。

agent-instruction add "[rule content]" --title "[title]" --rule="[rule-file]"
  • content（必需）：指令规则文本
  • --title（可选）：规则章节的标题
  • --rule（可选）：目标规则文件名（省略时会交互式提示）

示例：

agent-instruction add "Always use table-driven tests in Go" --title="Testing Standards" --rule="testing"
agent-instruction add "Never use global variables" --title="Code Standards"
agent-instruction add "Validate all user input before database queries" --rule="security"
build

根据所有规则配置生成或更新指令文件（CLAUDE.md、AGENTS.md）。

agent-instruction build
list

显示所有可用的规则文件及其内容。

agent-instruction list [--verbose]
  • --verbose（可选）：显示完整的规则内容及格式

最佳实践

  • 添加前先检查： 添加规则前运行 agent-instruction list --verbose，避免重复。
  • 更改后进行构建： 添加多条规则后，运行 agent-instruction build，将更改同步到 CLAUDE.md 和 AGENTS.md。
  • 使用描述性标题： 清晰具体的标题便于日后查找规则。
  • 将相关规则归类： 使用以类别命名的规则文件，例如 testing.json、security.json、golang.json、global.json。
  • 何时添加规则： 用户说“下次记住这一点”时、发现重复出现的错误时，或确立新标准时。

备注

此技能需要安装 agent-instruction CLI，且可在 PATH 中访问。CLI 会在 .agent-instruction/ 目录中管理规则文件，并在仓库根目录生成指令文件。

评论

支持 Markdown