关于 skill-name
用于编写和构建 Agent 技能的模板,包含环境配置、命令、示例、脚本、故障排查和参考资料等章节。它提供文档起点,并非已说明功能的可直接使用技能。
主要功能
- 01记录先决条件与配置
- 02添加快速入门命令
- 03说明脚本和命令
- 04编写使用示例
- 05整理故障排查与参考资料
适用场景
- 01创建新的技能目录
- 02组织技能文档结构
- 03列出脚本和工作流示例
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ resciencelab/ opc-skills --skill skill-name安装后在 Claude Code 中输入/skill-name确认已加载。
详细介绍
技能名称
简要介绍技能及其用途。
先决条件
列出所有设置要求:
- 所需的环境变量
- 所需的 API 密钥
- 依赖项(已在上方的 frontmatter 中列出)
设置示例:
export SKILL_API_KEY="your_api_key"
快速开始
快速了解如何使用此技能:
cd <skill_directory>
python3 scripts/command.py --option value
使用示例
示例 1:基本用法
python3 scripts/script.py "input"
输出:
Expected output here
示例 2:高级用法
python3 scripts/script.py "input" --flag --option value
命令
所有命令均在技能目录中运行。
命令 1
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value
命令 2
python3 scripts/script2.py "param1" "param2"
脚本
script1.py- 说明此脚本的用途script2.py- 说明此脚本的用途
API 信息
- 基础 URL:(如适用)
- 速率限制:(如适用)
- 身份验证:(身份验证方式)
- 文档:官方文档链接
故障排除
问题 1
症状:问题描述
解决方案:
- 步骤 1
- 步骤 2
问题 2
症状:问题描述
解决方案:
- 步骤 1
- 步骤 2
示例
完整的工作流示例请参见 examples/ 目录。
参考资料
备注
- 重要备注 1
- 重要备注 2
Frontmatter 指南
本文件顶部必须包含 YAML frontmatter:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | ✓ | 唯一标识符(kebab-case) |
description | string | ✓ | 说明技能的用途及适用时机。在行内加入触发关键词和“Use when...”适用场景。 |
创建技能
- 将此模板复制到
skills/your-skill-name/ - 更新 YAML frontmatter
- 编写 SKILL.md 文档
- 在
scripts/中添加 Python/shell 脚本 - 在
examples/中添加使用示例 - 在
skills.json中添加技能条目 - 在提交 PR 前使用你的 Agent 进行测试
评论
支持 Markdown