用途
add-skill 是 Coralogix cx-cli 项目中的一个技能,用于在 skills/ 目录下创建面向用户的技能,教会 AI 智能体如何使用某个 cx CLI 命令。它通常由 add-command 工作流的第 6 步调用,也可以在为已有命令编写文档时独立使用。
主要能力
该技能提供了一套端到端的工作流,覆盖从理解领域到最终验证的完整过程:
- 理解领域:明确要文档化的 cx 命令及其所有子命令(例如
cx alerts list、cx alerts get、cx alerts create),列出关键操作、标志和输出格式,并判断是否需要将密集的参考材料(如 schema、枚举目录、字段参考或超过约 100 行的语言语法)拆分到单独的references/文件。 - 阅读现有技能:在编写前先阅读
contributing/adding-a-skill.md(含目录结构、前置字段约定、参考文件规则和可复制模板)与skills/README.md,并至少研究两个现有技能,例如skills/cx-alerts/SKILL.md、skills/cx-telemetry-querying/SKILL.md、skills/cx-dashboards/SKILL.md、skills/cx-cost-optimization/SKILL.md,以掌握项目模式。 - 创建 SKILL.md:在
skills/cx-<domain-name>/SKILL.md下编写技能文件,所有技能目录使用cx-前缀。description 前置字段是主要触发机制,需包含至少 10 个触发短语,覆盖显式命令名、用户意图、同义词变体和领域术语。正文按标题与简介、CLI 命令表、工作流/调查步骤、关键原则、附加资源的顺序组织。 - 添加参考文件并更新 README:区分共享参考(语言指南、遥测支柱操作指南放入
skills/shared/)与技能本地参考(技能专属 schema 或模板放入skills/cx-your-domain/references/)。若使用共享参考,需在scripts/sync-shared-references.sh中登记并运行脚本同步。 - 验证:检查前置字段(name 与目录匹配、description 含 10 个以上触发短语、metadata.version 为 "0.1.0")、正文完整性、参考链接有效性、README 更新、无冗余、共享参考已同步、智能体可读性。
使用方式
该技能以工作流步骤的形式给出操作指引,每一步都包含具体的检查项和命令示例。例如在同步共享参考时运行 bash scripts/sync-shared-references.sh,在高级触发优化时可使用 /skill-creator 技能进行基于评估的描述测试。
适用场景
适用于需要为 cx CLI 命令创建面向 AI 智能体的技能文档的场景,包括:用户要求“添加技能”“创建技能”“为 cx 某功能写技能”“创建 SKILL.md”“教智能体如何使用”“将命令文档化为技能”等。也适用于在 add-command 工作流中到达技能创建步骤时。
限制
技能正文建议保持在约 200 行以内,超过 100 行的密集材料应移至 references/。技能面向 AI 智能体而非人类直接阅读,需写出智能体可逐步执行的指令。关于具体命令的 schema、枚举等细节,资料中未提供完整内容,需参考项目内的 contributing/adding-a-skill.md 及相关参考文件。