加载中...
返回AI 编程实战
AI 编程知识库 · AI 编程实战 · Skill 进阶

SKILL.md Frontmatter 完全手册

Frontmatter 字段全景图:每个字段都有精确用途

阅读提示:每个 Frontmatter 字段都有其精确用途,理解底层逻辑比记忆语法更重要。本文基于官方文档和实战经验总结。


4.1 Frontmatter 是什么

SKILL.md 文件由两部分组成:

---                                    ← Frontmatter 起始标记
name: my-skill
description: 这个 Skill 的功能说明
---                                    ← Frontmatter 结束标记

# Skill 内容                           ← Markdown 正文
给 Claude 的指令...

Frontmatter(前置数据)是位于文件开头的 YAML 元数据块,用 --- 包围。它告诉 Claude Code:

  • 这个 Skill 叫什么(name)
  • 什么时候使用(description)
  • 谁可以调用(user-invocable、disable-model-invocation)
  • 允许用什么工具(allowed-tools)
  • 在哪里执行(context、agent)
  • 用什么模型(model)

4.2 核心字段详解

name:标识符

name: code-reviewer

规则:

  • 只能包含小写字母、数字和连字符
  • 最大 64 个字符
  • 如果省略,默认使用目录名

命名空间机制:

来源 Skill 名称 调用方式
项目级 .claude/skills/ review /review
用户级 ~/.claude/skills/ review /review
Plugin review /plugin-name:review

优先级:Enterprise > 个人 > 项目 > Plugin


description:Claude 决策的唯一依据

description: 审查代码中的安全漏洞。当分析代码变更、准备安全审计或用户提到"安全审查"时使用。

这是最重要的字段——Claude 完全依赖 description 决定是否激活你的 Skill。

精确描述公式

description: [做什么] + [何时使用] + [什么情况不用]

好例子:

AI 编程知识库会员专享内容
开通后解锁「SKILL.md Frontmatter 完全手册」全文,AI 编程知识库全年访问

扫码添加企业微信,找大熊掌门开通会员

企业微信二维码

添加后说明想开通的会员类型即可

加载中...