Skip to content

[Doc] 自定义 Skill 的 SKILL.md 必须包含 YAML Front Matter #2008

Description

@lcq225

问题现象

在 CoPaw v0.1.0post1版本后,自定义 Skill 的 SKILL.md 文件如果没有 YAML Front Matter,会导致技能加载失败:

ERROR ... Failed to register skill 'my_skill': The SKILL.md file must have a YAML Front Matter including `name` and `description` fields.

官方文档说明

根据 Skills 文档,YAML Front Matter 的描述是:

可选 在文件开头用 YAML front matter 定义元数据

文档中写的是"可选",但实际运行时会报错,存在文档与代码不一致的问题。

正确格式

SKILL.md 文件必须以 YAML Front Matter 开头:

---
name: my_skill
description: 技能的简短描述
---

# 技能标题

技能的详细说明...

字段说明

字段 必填 说明
name ✅ 技能名称,用于调用
description ✅ 技能描述,用于 Agent 理解何时使用
metadata ❌ 可选元数据,如版本号、emoji 等

可能受影响的场景

  1. 从旧版本升级 — 旧版本可能不检查格式
  2. 手动创建 Skill — 用户可能不知道格式要求
  3. 复制官方 Skill 后修改 — 如果删除了 YAML 头部

建议

  1. 更新文档 — 将"可选"改为"必填",明确说明格式要求
  2. 或修改代码 — 如果确实是"可选",则代码不应报错
  3. 增加提示 — 在 copaw skill create 命令中生成模板时包含 YAML 头部

临时解决方案

如果遇到此问题,在 SKILL.md 文件开头添加 YAML Front Matter 即可:

---
name: 技能名称
description: 技能描述
---

参考

Activity

  1. xieyxclack commented on Mar 21, 2026

    @xieyxclack
    Member

    Thank you for reporting! The name and description fields are required.

  2. ltzu929 commented on Mar 21, 2026

    @ltzu929
    Contributor

    Thank you for reporting! The name 和 description fields are required.

    我想修复这个文档问题。

    我会把 skills.zh.md 和 skills.en.md 中的"可选"改成"必填",并补充 name 和 description 是必填字段的说明。

  3. moved this from Todo to In progress in QwenPawon Mar 26, 2026
  4. moved this from In progress to Done in QwenPawon Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    • Status
      Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions