Skip to main content

A linter for Claude SKILL.md files.

Project description

doodle

A linter for Claude SKILL.md files. Catches vague descriptions, oversized bodies, hardcoded paths, and silent trigger failures.

MIT 12 rules Open VSX Quality Report


Overview

In late 2025 Anthropic introduced SKILL.md, a markdown format with YAML frontmatter that extends Claude with custom skills. By mid-2026 more than 5,000 skills have been published across community marketplaces. Anthropic's own issue tracker attributes 80% of skill trigger failures to vague descriptions (anthropics/skills#267), yet no static tooling for the format existed.

doodle closes that gap. Twelve static rules, each citing Anthropic's authoring guide or a documented community issue, plus a trigger-accuracy harness for measuring whether skills actually fire on natural-language prompts.

Install

pip install git+https://github.com/krishyaid-coder/doodle.git

Requires Python 3.10 or newer. Runtime dependencies: PyYAML, and tomli on Python 3.10. PyPI publication is pending; once complete, pip install doodle-lint will work.

Verify:

doodle --version
doodle --list-rules

Usage

# Scaffold a new skill that passes the linter out of the box
doodle init my-skill --eval          # creates ./my-skill/{SKILL.md,eval.yaml}

# Lint a single skill
doodle path/to/SKILL.md

# Lint a directory recursively
doodle ./skills

# JSON output for CI
doodle ./skills --format=json

# SARIF output for GitHub code scanning
doodle ./skills --format=sarif > doodle.sarif

# Apply auto-fixes for safe rules
doodle ./skills --fix

# Promote info to warning, warning to error
doodle --strict ./skills

# Disable a specific rule
doodle --ignore=body/emoji ./skills

# Explain a rule
doodle --explain desc/vague-trigger

Exit codes: 0 clean, 1 warnings, 2 errors, 3 tool error.

Phase 2: trigger-accuracy eval

# Requires: pip install ".[eval]", npm install -g promptfoo, ANTHROPIC_API_KEY
doodle eval --generate path/to/SKILL.md    # Draft a starter eval.yaml via Claude
doodle eval path/to/SKILL.md               # Run the eval, report the score
doodle eval path/to/SKILL.md --dry-run     # Preview the Promptfoo config

Full workflow: docs/EVAL.md.

VS Code / Cursor extension

The extension is published on the Open VSX Registry and works in Cursor, VSCodium, Windsurf, and VS Code with Open VSX enabled.

Features: real-time diagnostics, status bar with finding counts, hover messages linking to the rule catalog, quick-fix code actions for fixable rules, and a doodle eval bridge command.

Install from your editor's Extensions panel (search doodle), or via CLI:

# Cursor, VSCodium, Windsurf (Open VSX is the default gallery)
code --install-extension krishyaid-coder.doodle-lint

# Vanilla VS Code: install the VSIX from the latest GitHub Release
curl -L -o /tmp/doodle.vsix \
  https://github.com/krishyaid-coder/doodle/releases/latest/download/doodle-lint-0.2.0.vsix
code --install-extension /tmp/doodle.vsix

The extension shells out to the CLI installed above. Upgrading the CLI upgrades the extension's rules automatically.

Full extension docs: vscode/README.md.

CI (GitHub Action)

- uses: krishyaid-coder/doodle@v0
  with:
    path: ./skills
    strict: true
    fail-on: warning   # warning | error | never

Rules

Each rule cites either Anthropic's authoring documentation or a documented community issue. Full spec with examples, in-sample frequency, and citations: RULES.md.

Rule Severity Fixable Description
desc/too-long warning no Description longer than 250 characters
desc/too-short warning no Description shorter than 60 characters or missing
desc/no-trigger-phrase warning no No explicit "Use when" or "Trigger with" phrasing
desc/vague-trigger warning no Trigger overlaps Claude's default behavior
body/too-long warning no Body longer than 500 lines
body/way-too-long error no Body longer than 1500 lines
body/absolute-user-path warning no Contains /Users/, /home/, or ~/ outside fences
body/emoji info (off by default) yes Emoji in body. Enable via --strict or config
fm/name-mismatch-dir warning no Frontmatter name doesn't match parent directory
fm/missing-allowed-tools warning no Extended dialect uses tools but omits scoping
fm/unknown-field info no Anthropic dialect has non-standard field
hygiene/desc-blank-lines info yes Description contains embedded blank lines

Architecture

One Python package, six source files. Data flow: files → parser → rule registry → severity gate → formatter.

flowchart LR
    A[SKILL.md files] -->|read| B[Parser]
    B -->|ParsedSkill| C[Rule registry]
    Cfg[.doodle.toml] -->|custom rules<br/>+ overrides| C
    C -->|Finding stream| D[Severity gate]
    D -->|filtered| E{Formatter}
    E -->|text| F[stdout]
    E -->|json / sarif| G[CI / dashboard]

Components:

  • parser: splits frontmatter from body and auto-detects the dialect.
  • rule registry: runs built-in and custom rules, applies severity overrides, filters by dialect and per-path globs.
  • custom rules: pattern and frontmatter-required rules loaded from .doodle.toml.
  • formatter: renders findings as colored text, JSON, or SARIF.

Full component reference, sequence diagrams, and extension points: docs/ARCHITECTURE.md.

Dialects

Two SKILL.md dialects exist in the wild. doodle auto-detects.

Some rules apply to both. Others are dialect-scoped.

Custom rules (teams and enterprise)

Drop a .doodle.toml in your project root. No Python required for regex-based rules or frontmatter requirements.

[options]
dialect = "extended"
fail-on = "warning"

[severity]
"body/emoji" = "off"
"body/too-long" = "info"

[[paths]]
glob = "**/experiments/**/SKILL.md"
disabled = ["desc/vague-trigger", "body/too-long"]

[[rules]]
id = "acme/no-customer-pii"
kind = "pattern"
pattern = "(?i)\\bcustomer_[a-z]+\\b"
applies-to = "body"
severity = "error"
message = "Customer PII tokens are not allowed in skills."
suggestion = "Use 'user_<role>' instead."

[[rules]]
id = "acme/require-team-tag"
kind = "frontmatter-required"
fields = ["team", "data-classification"]
severity = "error"
message = "Internal skills must declare team and data-classification."

Config is discovered by walking up the directory tree. Force a path with --config. For rules requiring Python logic, see docs/EXTENDING.md.

Roadmap

Version Feature Status
v0.1 Static linter, 12 rules, CLI, GitHub Action shipped
v0.2 .doodle.toml config, custom rules, per-path overrides, severity overrides shipped
v0.3 --fix, SARIF output, parse-error suggestions shipped
v0.4 doodle eval trigger-accuracy harness, --generate starter eval suites shipped
vscode 0.2 VS Code extension on Open VSX Registry shipped
v0.5 doodle init skill scaffold that passes the linter out of the box shipped
v0.6 (next) doodle badge quality badges, expanded auto-fix coverage, refreshed 200-skill Quality Report planned
v1.0 PyPI publication, community eval-suite library, pre-commit hook integration planned
Phase 4 Managed scanner and quality-badge dashboard for marketplace operators exploring
Phase 5 LSP extraction for Neovim, Zed, JetBrains via the same rule engine if demand

Validation

I ran doodle against 62 published SKILL.md files from the most-popular repositories: DietrichGebert/ponytail (33k stars), anthropics/skills, obra/superpowers, and alirezarezvani/claude-skills. 82 percent of the sample had at least one quality finding, including Anthropic's own first-party skills and ponytail's reference skill.

Full methodology, per-repository breakdown, and raw data: docs/QUALITY_REPORT.md.

Documentation

License

MIT. The CLI and rule-set are MIT-licensed permanently. Any future hosted services will be a separate repository under a separate license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doodle_lint-0.5.0.tar.gz (56.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doodle_lint-0.5.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

Details for the file doodle_lint-0.5.0.tar.gz.

File metadata

  • Download URL: doodle_lint-0.5.0.tar.gz
  • Upload date:
  • Size: 56.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for doodle_lint-0.5.0.tar.gz
Algorithm Hash digest
SHA256 51cffef6aaf1d3eff5d7d38013ef31361e4f3b3a143f61d2aab4121fdc2b9f78
MD5 ddfacdd1226ab490722efa5fac5d4ee1
BLAKE2b-256 98fad2c42fd94244e52518e4932d9dba80b5eb8f9b0abece794bec0e955f75cd

See more details on using hashes here.

File details

Details for the file doodle_lint-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: doodle_lint-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for doodle_lint-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bb663868502789eadaa177c6341a97050feff0d483f371606af19ba80ff7e40b
MD5 0b66cc86f3219b1edd41a0900f2ac18c
BLAKE2b-256 7c1aff5717cc6d9495be49676e4063f7cfc3061f0f6906af880a8f47d831672b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page