SuperAPI AI 工具集

validate-skill

编程与开发

查看项目

更新于 10-16 02:21

技能介绍

用途

validate-skill 用于按照 AgentSkills 规范校验技能目录。它可以检查技能的 frontmatter 是否规范、必填字段是否齐全、命名是否符合约定,从而帮助开发者发现技能结构上的问题。

适合在以下场景使用:

  • 在任意智能体的技能目录中创建新技能时(例如 .claude/skills/、.cursor/skills/ 等)
  • 审查会修改技能内容的 PR 时
  • 在发布前验证技能结构时

主要能力

该技能提供脚本 validate-skill.ts,用于校验一个或多个技能目录。

运行命令:

bunx @plaited/development-skills validate-skill [paths...]

参数:

  • paths:要校验的路径(默认为当前智能体的技能目录)

选项:

  • --json:以 JSON 形式输出结果

使用示例:

# 校验当前目录下 .claude/skills/ 中的技能
bunx @plaited/development-skills validate-skill .claude/skills

# 校验 Cursor 技能
bunx @plaited/development-skills validate-skill .cursor/skills

# 校验某个特定技能
bunx @plaited/development-skills validate-skill .claude/skills/typescript-lsp

# 校验多个路径并以 JSON 输出
bunx @plaited/development-skills validate-skill .claude/skills .cursor/skills --json

校验规则

必填字段:

  • name:技能名称(小写,可包含字母数字和连字符)
  • description:技能简要描述

命名约定:

  • 名称必须为小写
  • 只允许字母数字字符和连字符
  • 不能以连字符开头或结尾
  • 不能包含连续连字符
  • 最多 64 个字符
  • 目录名必须与技能名称一致

可选字段:

  • license:许可证标识
  • compatibility:运行时要求
  • allowed-tools:以逗号分隔的允许工具列表
  • metadata:用于附加元数据的键值对

输出格式

人类可读(默认):

✓ .claude/skills/typescript-lsp
✓ .cursor/skills/my-skill
✗ .claude/skills/invalid-skill
  ERROR: Missing required field in frontmatter: 'description'

2/3 skills valid

JSON(--json):

[
  {
    "valid": true,
    "path": ".cursor/skills/my-skill",
    "errors": [],
    "warnings": [],
    "properties": {
      "name": "my-skill",
      "description": "..."
    }
  }
]

相关技能

  • typescript-lsp:结构良好、带有脚本的技能示例
  • code-documentation:TypeScript/JavaScript 代码的 TSDoc 标准

限制

资料未提供关于该技能的收费、价格、平台兼容范围、具体效果或额外使用步骤等信息。