skills/.github/scripts/validate_skills.py at aac7cd5bf868816432134458e593d8bd76f65a0b · amd/skills · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
#!/usr/bin/env -S uv run --quiet
# /// script
# requires-python = ">=3.10"
# dependencies = ["pyyaml>=6.0"]
# ///
"""Validate AMD skills against the standardized Agent Skills format.

Enforces the rules documented in CONTRIBUTING.md:

  - SKILL.md exists at the skill root
  - YAML frontmatter is parseable
  - `name` is lowercase-with-hyphens, <=64 chars, no `anthropic`/`claude`
    substrings, and matches the directory name
  - `description` is a non-empty string <=1024 chars
  - SKILL.md body is <=500 lines

Also validates that `.claude-plugin/marketplace.json` is in sync with the
skills on disk: every skill must have a marketplace entry, and every
marketplace entry must point at an existing skill.

Run from the repo root:

    ./.github/scripts/check.sh                          # used locally; thin wrapper
    uv run .github/scripts/validate_skills.py           # validate every skill + manifest
    uv run .github/scripts/validate_skills.py --skills-dir skills
    uv run .github/scripts/validate_skills.py --list    # print skill names as JSON
    uv run .github/scripts/validate_skills.py --skill rocm-doctor   # one skill only
    uv run .github/scripts/validate_skills.py --marketplace-only    # manifest only

The `--list` / `--skill` options let CI validate each skill in its own job
(see .github/workflows/validate.yml) so a single bad skill doesn't mask the
status of the others.

Exits non-zero if any validated skill (or the marketplace check) fails.
"""

from __future__ import annotations

import argparse
import json
import re
import sys
from dataclasses import dataclass, field
from pathlib import Path

import yaml

REPO_ROOT = Path(__file__).resolve().parent.parent.parent
DEFAULT_SKILLS_DIR = REPO_ROOT / "skills"
CLAUDE_MARKETPLACE = REPO_ROOT / ".claude-plugin" / "marketplace.json"

# Limits from CONTRIBUTING.md and the standardized Agent Skills format.
MAX_NAME_LEN = 64
MAX_DESCRIPTION_LEN = 1024
MAX_BODY_LINES = 500

NAME_RE = re.compile(r"^[a-z0-9]+(-[a-z0-9]+)*$")
FRONTMATTER_RE = re.compile(
    r"\A---\r?\n(?P<frontmatter>.*?)\r?\n---\r?\n?(?P<body>.*)\Z",
    re.DOTALL,
)
RESERVED_NAME_SUBSTRINGS = ("anthropic", "claude")


@dataclass
class SkillReport:
    skill: str
    errors: list[str] = field(default_factory=list)


def validate_skill(skill_dir: Path) -> SkillReport:
    """Run every validation rule against `skill_dir` and return a report."""
    report = SkillReport(skill=skill_dir.name)
    skill_md = skill_dir / "SKILL.md"

    if not skill_md.exists():
        report.errors.append("Missing SKILL.md.")
        return report

    text = skill_md.read_text(encoding="utf-8")
    match = FRONTMATTER_RE.match(text)
    if match is None:
        report.errors.append(
            "SKILL.md must start with a `---` YAML frontmatter block "
            "followed by `---` on its own line."
        )
        return report

    try:
        frontmatter = yaml.safe_load(match.group("frontmatter"))
    except yaml.YAMLError as exc:
        report.errors.append(f"YAML frontmatter is invalid: {exc}")
        return report

    if not isinstance(frontmatter, dict):
        report.errors.append(
            "YAML frontmatter must be a mapping with at least `name` "
            "and `description`."
        )
        return report

    _validate_name(frontmatter.get("name"), skill_dir.name, report)
    _validate_description(frontmatter.get("description"), report)
    _validate_body(match.group("body"), report)
    return report


def _validate_name(name: object, dir_name: str, report: SkillReport) -> None:
    if not isinstance(name, str) or not name:
        report.errors.append("Frontmatter `name` is missing or not a non-empty string.")
        return

    if len(name) > MAX_NAME_LEN:
        report.errors.append(
            f"`name` length {len(name)} exceeds {MAX_NAME_LEN} characters."
        )
    if not NAME_RE.match(name):
        report.errors.append(
            f"`name` `{name}` must be lowercase-with-hyphens "
            "(letters, digits, single hyphens between segments)."
        )
    for sub in RESERVED_NAME_SUBSTRINGS:
        if sub in name.lower():
            report.errors.append(f"`name` may not contain `{sub}`.")
    if name != dir_name:
        report.errors.append(
            f"`name` `{name}` must match the skill directory name `{dir_name}`."
        )


def _validate_description(description: object, report: SkillReport) -> None:
    if not isinstance(description, str) or not description:
        report.errors.append(
            "Frontmatter `description` is missing or not a non-empty string."
        )
        return
    if len(description) > MAX_DESCRIPTION_LEN:
        report.errors.append(
            f"`description` length {len(description)} exceeds "
            f"{MAX_DESCRIPTION_LEN} characters."
        )


def _validate_body(body: str, report: SkillReport) -> None:
    # Skip surrounding blank lines so the blank line after `---` doesn't
    # inflate the count.
    lines = body.splitlines()
    while lines and not lines[0].strip():
        lines.pop(0)
    while lines and not lines[-1].strip():
        lines.pop()
    if len(lines) > MAX_BODY_LINES:
        report.errors.append(
            f"SKILL.md body is {len(lines)} lines; max is {MAX_BODY_LINES}. "
            "Move reference material into sibling files (reference.md, "
            "examples.md, ...) and link to them from SKILL.md."
        )


def discover_skills(root: Path) -> list[Path]:
    """List skill directories under `root`, ignoring dotfiles."""
    if not root.exists():
        return []
    return sorted(
        p for p in root.iterdir() if p.is_dir() and not p.name.startswith(".")
    )


def validate_claude_marketplace(skill_dirs: list[Path]) -> list[str]:
    """Return error strings if marketplace entries don't match skills/ on disk.

    The marketplace's human-readable `description` is intentionally allowed
    to differ from the SKILL.md description (per CONTRIBUTING.md), so this only
    enforces that names and source paths line up.
    """
    if not CLAUDE_MARKETPLACE.exists():
        return [
            f"Missing {CLAUDE_MARKETPLACE.relative_to(REPO_ROOT)}; expected one "
            "entry per skill."
        ]

    try:
        data = json.loads(CLAUDE_MARKETPLACE.read_text(encoding="utf-8"))
    except json.JSONDecodeError as exc:
        return [f"{CLAUDE_MARKETPLACE.relative_to(REPO_ROOT)}: invalid JSON: {exc}"]

    plugins = data.get("plugins") if isinstance(data, dict) else None
    if not isinstance(plugins, list):
        return [
            f"{CLAUDE_MARKETPLACE.relative_to(REPO_ROOT)}: top-level `plugins` "
            "array is missing."
        ]

    errors: list[str] = []
    skill_names = {p.name for p in skill_dirs}
    listed_names: set[str] = set()

    for idx, entry in enumerate(plugins):
        if not isinstance(entry, dict):
            errors.append(f"plugins[{idx}] must be an object.")
            continue
        name = entry.get("name")
        source = entry.get("source")
        description = entry.get("description")

        if not isinstance(name, str) or not name:
            errors.append(f"plugins[{idx}] is missing a non-empty `name`.")
            continue
        listed_names.add(name)

        if name not in skill_names:
            errors.append(
                f"plugins[{idx}] (`{name}`) has no matching directory under skills/."
            )
            continue

        expected_source = f"./skills/{name}"
        if source != expected_source:
            errors.append(
                f"plugins[{idx}] (`{name}`): `source` must be `{expected_source}`, "
                f"got `{source}`."
            )
        if not isinstance(description, str) or not description.strip():
            errors.append(
                f"plugins[{idx}] (`{name}`) is missing a non-empty `description`."
            )

    for missing in sorted(skill_names - listed_names):
        errors.append(
            f"skills/{missing} has no entry in "
            f"{CLAUDE_MARKETPLACE.relative_to(REPO_ROOT)}."
        )

    return errors


def _print_report(report: SkillReport) -> int:
    """Print a single skill report and return its error count."""
    status = "OK  " if not report.errors else "FAIL"
    print(f"[{status}] {report.skill}")
    for err in report.errors:
        print(f"        {err}")
    return len(report.errors)


def list_skills(skills_dir: Path) -> int:
    """Print discovered skill names as a compact JSON array (for CI matrices)."""
    skills = discover_skills(skills_dir)
    if not skills:
        print(f"No skills found under {skills_dir}", file=sys.stderr)
        return 1
    print(json.dumps([p.name for p in skills], separators=(",", ":")))
    return 0


def run_single(skills_dir: Path, name: str) -> int:
    """Validate a single skill directory by name (no marketplace cross-check)."""
    skill_dir = skills_dir / name
    if not skill_dir.is_dir():
        print(f"No such skill directory: {skill_dir}", file=sys.stderr)
        return 1

    errors = _print_report(validate_skill(skill_dir))
    print(f"\nSummary: {errors} error(s) in skill `{name}`")
    return 0 if errors == 0 else 1


def run_marketplace(skills_dir: Path) -> int:
    """Validate only that marketplace.json is in sync with skills on disk."""
    skills = discover_skills(skills_dir)
    if not skills:
        print(f"No skills found under {skills_dir}", file=sys.stderr)
        return 1

    marketplace_errors = validate_claude_marketplace(skills)
    status = "OK  " if not marketplace_errors else "FAIL"
    print(f"[{status}] .claude-plugin/marketplace.json")
    for err in marketplace_errors:
        print(f"        {err}")
    print(f"\nSummary: {len(marketplace_errors)} error(s) in marketplace manifest")
    return 0 if not marketplace_errors else 1


def run(skills_dir: Path) -> int:
    skills = discover_skills(skills_dir)
    if not skills:
        print(f"No skills found under {skills_dir}", file=sys.stderr)
        return 1

    print(f"Validating {len(skills)} skill(s) in {skills_dir}\n")
    total_errors = 0
    for skill_dir in skills:
        total_errors += _print_report(validate_skill(skill_dir))

    marketplace_errors = validate_claude_marketplace(skills)
    marketplace_status = "OK  " if not marketplace_errors else "FAIL"
    print(f"\n[{marketplace_status}] .claude-plugin/marketplace.json")
    for err in marketplace_errors:
        print(f"        {err}")
    total_errors += len(marketplace_errors)

    print(f"\nSummary: {total_errors} error(s) across {len(skills)} skill(s)")
    return 0 if total_errors == 0 else 1


def main(argv: list[str] | None = None) -> int:
    parser = argparse.ArgumentParser(
        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
    )
    parser.add_argument(
        "--skills-dir",
        type=Path,
        default=DEFAULT_SKILLS_DIR,
        help=f"Directory containing skill folders (default: {DEFAULT_SKILLS_DIR}).",
    )
    group = parser.add_mutually_exclusive_group()
    group.add_argument(
        "--list",
        action="store_true",
        help="Print discovered skill names as a JSON array and exit.",
    )
    group.add_argument(
        "--skill",
        metavar="NAME",
        help="Validate only the named skill directory (skips the marketplace "
        "cross-check, which is repo-wide).",
    )
    group.add_argument(
        "--marketplace-only",
        action="store_true",
        help="Only validate that marketplace.json is in sync with skills/.",
    )
    args = parser.parse_args(argv)
    skills_dir = args.skills_dir.resolve()

    if args.list:
        return list_skills(skills_dir)
    if args.skill:
        return run_single(skills_dir, args.skill)
    if args.marketplace_only:
        return run_marketplace(skills_dir)
    return run(skills_dir)


if __name__ == "__main__":
    raise SystemExit(main())