技能最佳实践

文档 社区

技能解读

当前原文的自动摘译,尚未人工审校。

捆绑路径规则

解析相对于包含此SKILL.md的目录的捆绑路径。当从另一个工作目录调用助手时,首先将 <skill-best-practices-dir> 扩展到该目录,以便命令明确。

第 1 步:初始化并验证元数据

定义唯一的name:1-64 个字符、小写字母、数字和单个连字符。起草description:最多 1,024 个字符,以第三人称书写,包括负面触发器。执行验证脚本(只读帮助程序):在继续之前运行验证脚本以确保合规性:python3 <skill-best-practices-dir>/scripts/validate-metadata.py --name "[name]" --description "[description]"

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
文档
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@pedronauck · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
不需要
兼容的系统
未声明(默认跨平台)
运行环境要求
未检出明确要求
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 命令执行
网络行为
仅限本地
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

01
第 1 步:初始化并验证元数据

定义唯一的`name`:仅限 1-64 个字符、小写字母、数字和单个连字符。起草`description`:最多 1,024 个字符,以第三人称书写,包括负面触发器。执行验证脚本(只读帮助程序):在继续之前运行验证脚本以确保合规性:`python3 <skill-best-practices-dir>/scripts/validate-metadata.py --name "[name]" --description "[description]"`

02
第 2 步:构建目录

使用经过验证的`name`创建根目录。初始化以下子目录: `scripts/`:用于微型 CLI 工具和确定性逻辑。 `references/`:适用于扁平(一层深)上下文,如模式或 API 文档。 `assets/`:用于输出模板、JSON 模式或静态文件。

03
步骤 3:起草核心逻辑 (SKILL.md)

使用`assets/SKILL.template.md`中的模板作为起点。用第三人称命令编写所有指令(例如“提取文本”、“运行构建”)。强制渐进式披露:将主要逻辑控制在 500 行以下。如果过程需要大型模式或复杂的规则集,请将其移至`references/`。

04
第 4 步:识别并捆绑脚本

识别“脆弱”任务(正则表达式、复杂解析或重复的样板文件)。概述 `scripts/` 目录的单一用途脚本。确保脚本使用标准输出 (stdout/stderr) 向代理传达成功或失败信息。在`SKILL.md`中,通过代理工作目录中明确的路径引用捆绑的帮助程序(代理将键入调用它们的相同路径),而不是默默依赖于CWD的裸露`scripts/helper.py`片段。

05
第 5 步:最终逻辑验证

查看`SKILL.md`的“幻觉间隙”(智能体被迫猜测的点)。验证所有文件路径都是相对的并使用正斜杠 (`/`)。验证代理工作目录中每个引用的帮助器路径是否明确,并且是否说明了帮助器的角色(`read-only`、`bootstrap`或`mutating`)。阅读`references/checklist.md`并对照最终输出交叉引用每个清单项目。

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。