mcpField
W
write-agentmemory-skill

write-agentmemory-skill

github.com/rohitg00Agent 工作流30.0k10.9k 次安装今天更新
代码仓库

关于 write-agentmemory-skill

用于编写 agentmemory skills 的格式与维护指南。它规定统一的文件布局、内容结构和事实生成流程，以保持 skill 简洁并与源代码同步。

主要功能

  1. 01分层的 skill 文件布局
  2. 02规定章节顺序与内容规则
  3. 03Frontmatter 和描述编写指南
  4. 04自动生成参考资料
  5. 05生成器与 CI 漂移检查

适用场景

  1. 01创建新的 agentmemory skill
  2. 02将密集事实移至参考文件
  3. 03检查 skill 的生成数据是否漂移

安装

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

$npx skills add https://github.com/rohitg00/agentmemory --skill write-agentmemory-skill

安装后在 Claude Code 中输入/write-agentmemory-skill确认已加载。

附带文件TROUBLESHOOTING.md

详细介绍

agentmemory 技能遵循统一的分层格式，确保内容便于浏览、准确且及时更新。请严格按此格式编写。

目录结构

plugin/skills/<name>/
  SKILL.md      (required, under 100 lines)
  REFERENCE.md  (optional, dense facts; auto-generate data tables)
  EXAMPLES.md   (optional, worked transcripts)
  TROUBLESHOOTING.md (generated support file)

SKILL.md 规则

  • Frontmatter：包含 name、description、可选的 argument-hint 和 user-invocable。仅当技能由用户作为斜杠命令运行时，才将 user-invocable: true；参考类和知识类技能设为 false。
  • Description 由两句话组成，是 Agent 在决定是否加载技能时唯一可见的内容。第一句说明技能的能力。第二句以 "Use when" 开头，并列出具体触发条件。内容应与同类技能有所区分，少于 1024 个字符，并使用第三人称。
  • 正文顺序：Quick start（一个具体示例）、Why（指导原则）、Workflow（包含决策关卡的编号步骤）、Anti-patterns（针对最常见错误的 WRONG 与 RIGHT 对照提示）、Checklist、See also（交叉链接到同类技能）、Reference 或 Troubleshooting 指引。
  • 不超过 100 行。将详尽信息移至 REFERENCE.md，将示例移至 EXAMPLES.md。
  • 将支持文件保存在技能目录内，确保每个技能单独安装后都能正常使用。链接到 TROUBLESHOOTING.md；生成器会将共享的恢复说明复制到每个技能根目录。

保持内容时效

源代码中已有的事实（工具名称和参数、REST 端点、环境变量、连接适配器、钩子事件）必须通过生成器生成，不能手动填写。编辑源代码后，运行 npm run skills:gen。CI 会运行 npm run skills:check，并在发现偏差时失败，因此生成的表格不会落后于代码。

风格

不要提及外部产品或竞品名称。不要使用表情符号。不要使用长破折号。不要填充无关内容。把要点说清楚即可。

检查清单

  • Description 包含带有实际触发条件的 "Use when" 句子。
  • SKILL.md 不超过 100 行。
  • 不包含时效性声明，也不重复故障排除内容。
  • 包含具体示例；生成的事实来自生成器。
  • 交叉链接均有效，且只深入一层。

评论

支持 Markdown