Skip to main content

Security scanner for AI agent skills and instruction artifacts

Project description

skill-scanner

CI Publish TestPyPI Publish PyPI zizmor

skill-scanner reviews AI skill and instruction artifacts for security risk using:

  • OpenAI analysis
  • VirusTotal analysis

Requirements

  • Python 3.11+
  • uv
  • OpenAI and/or VirusTotal API key (at least one)

Install (from source)

uv sync --all-extras --group dev

Run with:

uv run skill-scanner --help

Alias:

uv run skillscan --help

What gets scanned

By default, discover and scan detect markdown-based skill/instruction artifacts (for example SKILL.md, AGENTS.md, CLAUDE.md, *.instructions.md, *.prompt.md, *.agent.md, .mdc).

Validated skill locations also include:

  • Windsurf: .windsurf/skills/*/SKILL.md, ~/.codeium/windsurf/skills/*/SKILL.md
  • Gemini CLI: .gemini/skills/*/SKILL.md, ~/.gemini/skills/*/SKILL.md
  • Cline: .cline/skills/*/SKILL.md, ~/.cline/skills/*/SKILL.md
  • OpenCode: .opencode/skills/*/SKILL.md, ~/.config/opencode/skills/*/SKILL.md

Use --path to target a specific file or folder.

Quick start

# See targets
uv run skill-scanner discover --format json

# Verify key/model configuration
uv run skill-scanner doctor

# Run live API checks (fails non-zero if checks fail)
uv run skill-scanner doctor --check

# Run a combined scan (if both keys are configured)
uv run skill-scanner scan --format summary

Key configuration and analyzer selection

scan requires at least one analyzer enabled.

  • If only OPENAI_API_KEY is available, AI runs and VT is disabled.
  • If only VT_API_KEY is available, VT runs and AI is disabled.
  • If both keys are available, VT findings are included and VT context is passed into AI analysis.
  • You can disable either analyzer with --no-ai or --no-vt.
  • If no model is configured, gpt-5.2 is used as a fallback model.

Use doctor --check to verify the provider/key/model connectivity.

API key safety

Use 1Password secret references instead of plaintext secrets:

OPENAI_API_KEY=op://Developer/OpenAI/api_key
VT_API_KEY=op://Developer/VirusTotal/api_key

Run the scanner through 1Password CLI so references are resolved at runtime:

op run --env-file=.env -- uv run skill-scanner scan --format summary

Security best practice:

  • Prefer a 1Password Service Account scoped to only the vault/items required for scanning (least privilege).

Reference:

Output formats

scan --format supports:

  • table (default)
  • summary
  • json
  • sarif

You can write output to a file with --output <path>.

Useful commands

# List providers
uv run skill-scanner providers

# Scan one path only
uv run skill-scanner scan --path ./some/skill/folder --format summary

# Increase scan concurrency (default: 8)
uv run skill-scanner scan --jobs 16 --format summary

# Enable verbose logs for troubleshooting
uv run skill-scanner scan --verbose --format summary

# List discovered targets without running analyzers
uv run skill-scanner scan --list-targets

# Scan only selected discovered targets (repeat --target)
uv run skill-scanner scan --target /absolute/path/to/SKILL.md --target /absolute/path/to/AGENTS.md --format summary

# Filter to medium+
uv run skill-scanner scan --min-severity medium --format summary

# Non-zero exit if high+ findings exist
uv run skill-scanner scan --fail-on high --format summary

# Verbose doctor checks
uv run skill-scanner doctor --check --verbose

--list-targets can be used without API keys because it only runs discovery and exits.

Exit behavior

  • 0: scan completed and fail threshold not hit
  • 1: --fail-on threshold matched
  • 2: no analyzers enabled (for example missing keys combined with flags), or --target did not match any discovered target

doctor --check exit behavior:

  • 0: all executed checks passed
  • 1: one or more checks failed

Notes and truncation visibility

scan now surfaces per-target notes in table and summary output, including:

  • analyzer failures (OpenAI or VirusTotal)
  • payload truncation when files are skipped due to the 400k-character AI payload limit
  • unreadable files excluded from payload construction

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

skill_scanner-0.1.2.tar.gz (133.0 kB view details)

Uploaded Source

Built Distribution

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

skill_scanner-0.1.2-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

Details for the file skill_scanner-0.1.2.tar.gz.

File metadata

  • Download URL: skill_scanner-0.1.2.tar.gz
  • Upload date:
  • Size: 133.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for skill_scanner-0.1.2.tar.gz
Algorithm Hash digest
SHA256 cb9bffb4a7320bb640e8ec162c36f4f8dc62abfdade80f846ddcfae37c0b4b4b
MD5 1f1de3e909dfcf8527a50e7ee10202ca
BLAKE2b-256 98b9e287275a6c7352422476fec5ec085d993c3f915fcd4d3305399873b7d62e

See more details on using hashes here.

Provenance

The following attestation bundles were made for skill_scanner-0.1.2.tar.gz:

Publisher: release.yml on thedevappsecguy/skill-scanner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file skill_scanner-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: skill_scanner-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 32.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for skill_scanner-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7e78964f09bff447cf7a913cb12b37902204b14db9eb3246cbb984f676c7d888
MD5 633014b479843bff125d3b846257fd14
BLAKE2b-256 270227ea740528a5d4a0e73693dcac69c9b149cebd30765e05da15e84019bf5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for skill_scanner-0.1.2-py3-none-any.whl:

Publisher: release.yml on thedevappsecguy/skill-scanner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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