jamie-bitflight/example-skill
plugins/plugin-creator/examples/skills/example-skill/SKILL.md
Demonstrates all available skill frontmatter fields. Use when you need a reference for skill configuration, when learning about skill capabilities, or when creating new skills from scratch.
$ install --global
skillsauthnpx skillsauth add jamie-bitflight/claude_skills example-skillInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 20, 2026, 7:04 AM18.0s1 file scanned
SKILL.md
- name:
- example-skill
- description:
- Demonstrates all available skill frontmatter fields. Use when you need a reference for skill configuration, when learning about skill capabilities, or when creating new skills from scratch.
- argument-hint:
- [topic]
- allowed-tools:
- Read, Grep, Glob, WebFetch
- model:
- sonnet
- user-invocable:
- true
- disable-model-invocation:
- false
- - matcher:
- Read
- - type:
- command
- command:
- echo 'File was read
- timeout:
- 5
Example Skill
This skill demonstrates all available frontmatter fields for Claude Code skills.
Purpose
Use this as a reference when creating new skills. All fields shown above are valid skill frontmatter options.
Field Descriptions
| Field | Type | Purpose | Constraints | Default |
| -------------------------- | ------- | -------------------------------- | ------------------------------- | --------------- |
| name | string | Display name | kebab-case, lowercase | directory name |
| description | string | When to load this skill | Must include trigger keywords | first paragraph |
| argument-hint | string | Autocomplete hint for / menu | Brief hint text | none |
| allowed-tools | string | Tools without permission prompts | Comma-separated tool names | none |
| model | string | Model when skill is active | sonnet, opus, haiku, or inherit | inherit |
| user-invocable | boolean | Show in / menu | true or false | true |
| disable-model-invocation | boolean | Prevent Claude auto-loading | true or false | false |
| hooks | object | Scoped hooks for skill lifecycle | Valid hook configuration object | none |
Note: The fields context and agent are deprecated and not documented in the official Skills reference as of January 2026.
Validation
Validate your skill using:
# Frontmatter and structure validation (checks token complexity, links, references)
uvx skilllint@latest check ./path/to/skill/SKILL.md
# Plugin validation (if skill is part of a plugin)
claude plugin validate ./path/to/plugin/
Common Validation Errors
| Error | Cause | Fix |
| -------------------------------------- | ----------------------------- | -------------------------------- |
| allowed-tools must be string | Used YAML array format | Change to comma-separated string |
| model must be sonnet/opus/haiku | Invalid model name | Use valid model identifier |
| YAML array detected | Used - Tool1 format | Change to Tool1, Tool2 format |
| Skill body exceeds 500 lines | Skill is too large | Split into multiple skills |
| Internal link points to missing file | Referenced file doesn't exist | Create file or fix path |
| Description too short | Less than 20 characters | Add trigger keywords and context |
Usage
This skill is for demonstration purposes only. When creating real skills, include only the fields you need.
Skill Location
Skills can be located in:
- User-level:
~/.claude/skills/skill-name/SKILL.md- Available across all projects - Project-level:
.claude/skills/skill-name/SKILL.md- Version controlled, team shared - Plugin:
plugins/plugin-name/skills/skill-name/SKILL.md- Bundled in a plugin
Sources
- Skills Reference (accessed 2026-01-28)
- Skills Overview - Complete reference
- Plugin Creator Validation Scripts
Related Skills
jamie-bitflight/xdg-base-directory
development
VerifiedTrustedCommunity
When an application needs to store config, data, cache, or state files. When designing where user-specific files should live. When code writes to ~/.appname or hardcoded home paths. When implementing cross-platform file storage with platformdirs.
39SKILL.mdUpdated Apr 30, 2026
jamie-bitflight/verification-gate
testing
VerifiedTrustedCommunity
Enforce mandatory pre-action verification checkpoints to prevent pattern-matching from overriding explicit reasoning. Use this skill when about to execute implementation actions (Bash, Write, Edit) to verify hypothesis-action alignment. Blocks execution when hypothesis unverified or action targets different system than hypothesis identified. Critical for preventing cognitive dissonance where correct diagnosis leads to wrong implementation.
39SKILL.mdUpdated Apr 30, 2026
jamie-bitflight/twelve-factor-app
tools
VerifiedTrustedCommunity
Reference guide for the Twelve-Factor App methodology — 15 principles (12 original + 3 modern extensions) for building portable, resilient, cloud-native applications. Use when evaluating application architecture, designing cloud-native services, reviewing codebases for methodology compliance, advising on configuration, scaling, observability, security, and deployment patterns. Incorporates the 2025 open-source community evolution and cloud-native reinterpretations of each factor.
39SKILL.mdUpdated Apr 30, 2026
jamie-bitflight/user-docs-to-ai-skill
tools
VerifiedTrustedCommunity
Converts user-facing documentation (how-to guides, tutorials, API references, examples) in any format — Markdown, PDF, DOCX, PPTX, XLSX, AsciiDoc, RST, HTML, Jupyter notebooks, man pages, TOML/YAML/JSON configs, and plain text — into Claude Code skill directories with SKILL.md plus thematically grouped references/*.md files. Use when given a docs directory or mixed-format documentation to transform into an AI skill. Uses MCP file-reader server for binary formats.
39SKILL.mdUpdated Apr 30, 2026