mcpField
S
skills-manual

skills-manual

github.com/bonkeyAgent 工作流070 次安装3 周前更新
代码仓库

关于 skills-manual

面向 AI 编码 Agent 技能作者的手册,涵盖技能结构、元数据、描述、指令编写、安全限制和迭代信号。

主要功能

  1. 01技能目录与文件规范
  2. 02YAML 前置元数据要求
  3. 03描述与触发条件指南
  4. 04指令编写建议
  5. 05迭代问题排查信号

适用场景

  1. 01按要求创建技能文件
  2. 02编写有助于技能加载的描述
  3. 03排查技能误触发或未触发

安装

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

$npx skills add https://github.com/bonkey/skills --skill skills-manual

安装后在 Claude Code 中输入/skills-manual确认已加载。

附带文件references/skill-builder-guide.md

详细介绍

技能手册

如何为 AI 编码 Agent 构建有效技能。完整的 Anthropic 指南请参阅 references/skill-builder-guide.md。

技能结构

your-skill-name/              # kebab-case, no spaces, no capitals, no underscores
  SKILL.md                    # Required — must be exactly this name (case-sensitive)
  references/                 # Optional — supporting docs loaded on demand
  scripts/                    # Optional — executable code
  assets/                     # Optional — templates, icons
  • 主文件必须命名为 SKILL.md,不能是 skill.md、SKILL.MD 或其他名称
  • 不要在技能文件夹中包含 README.md
  • 文件夹名称必须采用 kebab-case(例如,notion-project-setup)

YAML Frontmatter

---
name: your-skill-name                     # Required — kebab-case, must match folder name
description: "What and when."             # Required — max 1024 chars, no < > brackets
license: MIT                              # Optional
allowed-tools: "Bash(python:*) WebFetch"  # Optional — restrict tool access
metadata:                                 # Optional
  author: Name
  version: 1.0.0
---
安全限制
  • Frontmatter 中不得包含 XML 尖括号(< >)——它会出现在系统提示词中
  • 技能名称中不得包含“claude”或“anthropic”(这些名称已被保留)

编写描述

描述是最重要的字段。它控制技能何时通过渐进式披露加载:

  1. Frontmatter(始终加载)——Claude 会读取描述以判断相关性
  2. SKILL.md 正文(相关时加载)——完整说明
  3. 关联文件(按需加载)——参考资料、脚本、资源

描述必须同时包含:

  • 技能做什么
  • 何时使用——用户实际会说出的具体触发短语

好示例:

description: "Manages Linear project workflows including sprint planning,
  task creation, and status tracking. Use when user mentions 'sprint',
  'Linear tasks', 'project planning', or asks to 'create tickets'."

坏示例:

description: "Helps with projects."

排查方法:询问 Claude“你会在什么时候使用 [技能名称] 技能?”——它会引用描述,从而揭示缺少的内容。

编写说明

结构
---
name: your-skill
description: [...]
---

# Skill Name

## Instructions
Step-by-step workflow with clear actions.

## Examples
Common scenarios with expected inputs/outputs.

## Troubleshooting
Common errors, causes, and fixes.
规则
  • 先写最重要的规则
  • 描述要具体——包括命令、文件路径和预期输出
  • 按顺序执行的工作流使用编号步骤,指南使用项目符号
  • 展示正确和错误用法的示例
  • 包含常见故障的错误处理方法
  • 明确引用随附文件(例如,“请参阅 references/api-guide.md”)
  • 将 SKILL.md 控制在 5,000 词以内——详细文档移至 references/
  • 可组合性——假设其他技能可能会同时加载

迭代信号

信号含义修正方法
应加载时技能却未加载触发不足在描述中添加更多触发短语和关键词
技能为无关查询加载触发过度添加负向触发条件,缩小范围
Claude 不遵循说明过于冗长或含糊使用项目符号,明确表达,将细节移至参考资料
结果不一致缺少示例或验证添加示例、错误处理和质量检查

评论

支持 Markdown