mcpField
E
example-skill

example-skill

github.com/anthropicsAgent 工作流45.1k202 次安装1 天前更新
代码仓库

关于 example-skill

example-skill 是用于理解和编写 Claude Code 插件技能的参考技能，适合技能作者查阅结构、触发条件和内容组织方式。它概述必需文件、可选资料及编写描述的建议。

主要功能

  1. 01说明技能文件结构
  2. 02列出 frontmatter 字段
  3. 03提供触发描述编写建议
  4. 04概述技能内容准则
  5. 05列出技能设计实践

适用场景

  1. 01设计新的插件技能
  2. 02检查技能目录与文件
  3. 03编写技能触发描述

安装

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

$npx skills add https://github.com/anthropics/claude-plugins-official --skill example-skill

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

详细介绍

示例 Skill

此 skill 演示 Claude Code 插件 skill 的结构和格式。

概述

Skill 是由模型调用的能力，Claude 会根据任务上下文自主使用它们。与命令（由用户调用）或 Agent（由 Claude 生成）不同，skill 提供上下文指导，Claude 会将其整合到自己的回复中。

此 Skill 的适用场景

当用户的请求涉及以下内容时，此 skill 会激活：

  • 创建或理解插件 skill
  • 需要 skill 模板或参考
  • Skill 开发模式

Skill 结构

必需文件
skills/
└── skill-name/
    └── SKILL.md          # Main skill definition (required)
可选的支持文件
skills/
└── skill-name/
    ├── SKILL.md          # Main skill definition
    ├── README.md         # Additional documentation
    ├── references/       # Reference materials
    │   └── patterns.md
    ├── examples/         # Example files
    │   └── sample.md
    └── scripts/          # Helper scripts
        └── helper.sh

Frontmatter 选项

Skill 支持以下 frontmatter 字段：

  • name（必需）：Skill 标识符
  • description（必需）：触发条件 - 描述 Claude 应在何时使用此 skill
  • version（可选）：语义化版本号
  • license（可选）：许可证信息或引用

编写有效的描述

description 字段至关重要 - 它告诉 Claude 何时调用该 skill。

良好的描述模式：

description: This skill should be used when the user asks to "specific phrase", "another phrase", mentions "keyword", or discusses topic-area.

应包含：

  • 用户可能说出的特定触发短语
  • 表明相关性的关键词
  • 该 skill 涵盖的主题领域

Skill 内容准则

  1. 目的明确：说明该 skill 有助于什么
  2. 使用时机：定义激活条件
  3. 结构化指导：逻辑清晰地组织信息
  4. 可操作的说明：提供具体步骤
  5. 示例：在有帮助时包含实际示例

最佳实践

  • 让 skill 专注于单一领域
  • 编写能清楚表明何时激活的描述
  • 对于复杂的 skill，在子目录中包含参考资料
  • 测试该 skill 是否会在预期查询时激活
  • 避免与其他 skill 的触发条件重叠

评论

支持 Markdown