关于 make-skill-template
这是用于创建 GitHub Copilot Agent Skill 的模板,也可帮助理解 Agent Skills 规范。它涵盖 SKILL.md 结构、元数据、附带资源布局和验证。
主要功能
- 01创建技能目录和 SKILL.md
- 02说明元数据与描述要求
- 03指导附带资源的目录布局
- 04提供验证清单和命令
适用场景
- 01创建新的 GitHub Copilot 技能
- 02为技能规划脚本或参考资料
- 03使用前检查技能
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ github/ awesome-copilot --skill make-skill-template安装后在 Claude Code 中输入/make-skill-template确认已加载。
详细介绍
Make Skill Template
用于创建新 Agent Skill 的元技能。当你需要搭建新的技能文件夹、生成 SKILL.md 文件,或帮助用户理解 Agent Skills 规范时,可使用此技能。
何时使用此技能
- 用户要求“创建技能”“制作新技能”或“搭建技能”
- 用户希望为其 GitHub Copilot 配置添加专门的能力
- 用户需要帮助构建带有捆绑资源的技能
- 用户希望将此模板复制为起点
前提条件
- 理解该技能应实现的目标
- 清晰、富含关键词的能力和触发条件描述
- 了解所需的所有捆绑资源(脚本、参考文档、资产、模板)
创建新技能
第 1 步:创建技能目录
创建一个使用小写、连字符命名的新文件夹:
skills/<skill-name>/
└── SKILL.md # Required
第 2 步:生成带有 Frontmatter 的 SKILL.md
每个技能都需要包含 name 和 description 的 YAML frontmatter:
---
name: <skill-name>
description: '<What it does>. Use when <specific triggers, scenarios, keywords users might say>.'
---
Frontmatter 字段要求
| 字段 | 是否必填 | 约束 |
|---|---|---|
name | 是 | 1-64 个字符,仅允许小写字母/数字/连字符,必须与文件夹名称一致 |
description | 是 | 1-1024 个字符,必须描述它做什么以及何时使用 |
license | 否 | 许可证名称或对捆绑 LICENSE.txt 的引用 |
compatibility | 否 | 1-500 个字符,如需要可填写环境要求 |
metadata | 否 | 用于附加属性的键值对 |
allowed-tools | 否 | 预先批准工具的以空格分隔列表(实验性) |
Description 最佳实践
关键:description 是自动发现技能的主要机制。需包含:
- 技能做什么(能力)
- 何时使用它(触发条件、场景、文件类型)
- 用户可能在提示词中提到的关键词
好的示例:
description: 'Toolkit for testing local web applications using Playwright. Use when asked to verify frontend functionality, debug UI behavior, capture browser screenshots, or view browser console logs. Supports Chrome, Firefox, and WebKit.'
差的示例:
description: 'Web testing helpers'
第 3 步:编写技能正文
在 frontmatter 之后,添加 Markdown 指令。推荐的部分:
| 部分 | 用途 |
|---|---|
# 标题 | 简要概述 |
## 何时使用此技能 | 强化 description 中的触发条件 |
## 前提条件 | 所需工具、依赖项 |
## 分步工作流 | 任务的分步步骤 |
## 故障排除 | 常见问题与解决方案 |
## 参考资料 | 指向捆绑文档的链接 |
第 4 步:添加可选目录(如有需要)
| 文件夹 | 用途 | 何时使用 |
|---|---|---|
scripts/ | 可执行代码(Python、Bash、JS) | 执行操作的自动化 |
references/ | Agent 阅读的文档 | API 参考、模式、指南 |
assets/ | 按原样使用的静态文件 | 图像、字体、模板 |
templates/ | Agent 修改的起始代码 | 可扩展的脚手架 |
示例:完整技能结构
my-awesome-skill/
├── SKILL.md # Required instructions
├── LICENSE.txt # Optional license file
├── scripts/
│ └── helper.py # Executable automation
├── references/
│ ├── api-reference.md # Detailed docs
│ └── examples.md # Usage examples
├── assets/
│ └── diagram.png # Static resources
└── templates/
└── starter.ts # Code scaffold
快速开始:复制此模板
- 复制
make-skill-template/文件夹 - 重命名为你的技能名称(小写、连字符)
- 更新
SKILL.md:- 将
name:改为与文件夹名称一致 - 编写富含关键词的
description: - 将正文内容替换为你的指令
- 将
- 按需添加捆绑资源
- 使用
npm run skill:validate进行验证
验证清单
- 文件夹名称为小写并使用连字符
-
name字段与文件夹名称完全一致 -
description长度为 10-1024 个字符 -
description说明了做什么以及何时使用 -
description使用单引号包裹 - 正文内容少于 500 行
- 每个捆绑资产小于 5MB
故障排除
| 问题 | 解决方案 |
|---|---|
| 技能未被发现 | 用更多关键词和触发条件改进 description |
| name 验证失败 | 确保为小写、无连续连字符、与文件夹一致 |
| Description 过短 | 添加能力、触发条件和关键词 |
| 找不到资产 | 使用相对于技能根目录的相对路径 |
参考资料
- Agent Skills 官方规范:https://agentskills.io/specification
评论
支持 Markdown