Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/modiqo/skillspec/llms.txt

Use this file to discover all available pages before exploring further.

skillspec doctor is a read-only diagnostic that assesses agent follow-through risk for any SKILL.md skill source. It accepts local folders, public GitHub skill folder URLs, and public GitHub repo URIs. The report treats risk as the headline metric so users do not misread structural scoring as a grade of domain quality. Remote targets are staged through a temporary partial sparse checkout and cleaned up after the report. In the harness, assess skill maps to this read-only path and must stop after the report unless the user also explicitly asks to import or install.

Synopsis

skillspec doctor [target] [--json] [--html] [--markdown]
skillspec doctor checklist <source> [--stage entry|loop|exit] [--json]

Options

FlagDescription
<target>Local folder path, public GitHub tree/<branch>/... URL, blob/<branch>/... URL, or owner/repo shorthand.
--jsonEmit full machine report including structural_score and score_model. Mutually exclusive with --html and --markdown.
--htmlEmit a self-contained review page. Mutually exclusive with --json and --markdown.
--markdownEmit GitHub-flavored Markdown for run summaries and issue comments. Mutually exclusive with --json and --html.

doctor checklist options

FlagDescription
<source>Local folder, public GitHub URL, or shorthand. Same target types as doctor.
--stage entry|loop|exitWhich checklist stage to emit. Defaults to entry.
--jsonEmit checklist as JSON.

Target types

  • Local folder — A directory path. Can be a single skill folder or a multi-skill workspace root.
  • GitHub tree URLhttps://github.com/<owner>/<repo>/tree/<branch>/<path> (canonical GitHub folder shape).
  • GitHub blob URLhttps://github.com/<owner>/<repo>/blob/<branch>/<path> accepted when the path resolves to a folder rather than SKILL.md.
  • Owner/repo shorthandowner/repo or owner/repo/path.

Shape detection

doctor detects one of five shape kinds and tailors the report accordingly:
ShapeDescription
simple_skillA single atomic SKILL.md package. Receives full source-map structural scoring plus frontmatter discovery and agent drift risk.
multi_skill_workspaceA root with multiple SKILL.md packages. Receives aggregate workspace risk plus one package report per SKILL.md.
plugin_workspaceA plugin-shaped root with a skills/ directory and plugin metadata. Preserves plugin namespaces; reports namespace-level risk.
entry_skill_with_subskillsAn entry skill that references additional subskill packages.
non_skill_repositoryAn ordinary code repository with no SKILL.md. Shape-only report; no structural scoring.

Report sections

The default terminal report includes:
  • What this measures — a plain-language description of the risk model.
  • Shape Contract — detected kind, kind-specific handling rule, analysis status, skill-file count, package count, namespace count, plugin-root details, referenced skill paths, and next command implied by the shape gate.
  • Surface — visible skill activation metadata.
  • Findings — specific risk indicators and structural observations.
  • Likely Consequence — what agent drift risks the findings imply.
  • Next Step — actionable remediation or porting guidance.
  • Basis Summary — scoring basis and model.
Workspace reports also include workspace_identity with total source files, namespaced package count, namespace count, unique byte-identical SKILL.md content count, repeated content groups/occurrences, repeated frontmatter names, estimated copied-vs-referenced source tokens, and source_content_refs.

Examples

Assess a local skill folder:
skillspec doctor ./source-skill
Assess a public GitHub skill folder and emit a Markdown report:
skillspec doctor https://github.com/anthropics/skills/tree/main/skills/pdf --markdown
Assess a GitHub repo and capture JSON output for CI:
skillspec doctor https://github.com/owner/repo --json > doctor-report.json
Run a shape-specific import checklist for the entry stage:
skillspec doctor checklist ./source-skill --stage entry --json

doctor checklist

doctor checklist runs the same source-shape inspection as doctor and emits a shape-specific checklist for single SKILL folders, multi-skill roots, entry skills with subskills, plugin-shaped workspaces, or non-skill repositories. The checklist names activation policy, commands, repeat-until loops, required evidence, and forbids such as no blind bulk promotion or plugin flattening. It is read-only and exits non-zero for non-skill sources.
Output formats --json, --html, and --markdown are mutually exclusive. The JSON output preserves structural_score and score_model fields that are omitted from human-readable formats to avoid misinterpretation.
  • skillspec source stage <uri> — Stage a public GitHub source before doctor for explicit candidate inspection.
  • skillspec import-skill <path> — Draft a skill.spec.yml from a single prose SKILL.md after doctor confirms a simple_skill shape.
  • skillspec workspace map <source-root> — Map a multi-skill or plugin workspace after doctor identifies the shape.

Build docs developers (and LLMs) love