SuperAPI AI 工具集

skill-frontmatter

通用与其它

查看项目

更新于 10-15 23:49

技能介绍

用途:指导为 SKILL.md 编写 YAML frontmatter,让模型能正确判断是否加载该技能。适用于新建 SKILL.md、排查“技能不激活”问题、审查新增技能的 PR。

主要能力:说明必填字段只有 name 和 description。name 使用 kebab-case,需与所在目录同名,采用动词或角色或主题开头,并在技能集中保持唯一。description 是核心激活信号,建议三句式结构:第一句写技能做什么,第二句写何时使用(具体触发条件),第三句列出用户实际会说的激活关键词。长度建议 3-5 句、约 60-150 词,不超过约 200 词;语气用第二人称或祈使句,具体而非抽象,并点名工具与框架。关键词应包含领域术语、错误信息、工具名和任务动词,避免“development、coding”这类过泛词。

使用方式:按示例格式书写 frontmatter,多行字符串需用 | 保留格式。可在 CI 中校验 YAML,例如用 gray-matter 解析并检查 name、description 是否存在、description 是否过短。文中给出 find 与 Node 脚本两种校验思路。

限制与常见错误:name 与目录不一致可能导致技能不加载;多行字符串缺少 | 会丢失格式;YAML 缩进、---、冒号等易出错;描述过泛、只写做什么不写何时用、关键词无人会输入、多个技能描述重复都会导致匹配失败。写完应自检:若自己都说不清何时触发,模型同样无法判断。