askill
skillcraft

skillcraftSafety 85Repository

Creates and validates Agent Skills (SKILL.md). Use when creating skills, writing frontmatter, or validating skill structure.

2 stars
1.2k downloads
Updated 3 weeks ago

Package Files

Loading files...
SKILL.md

Skills Development

Create skills that follow the Agent Skills specification—an open format supported by Claude Code, Cursor, VS Code, GitHub Copilot, Codex, and other agent products.

Workflow

  1. Discovery — Understand what the skill should do
  2. Archetype Selection — Choose the best pattern
  3. Initialization — Create skill structure
  4. Customization — Tailor to specific needs
  5. Validation — Verify quality before committing

Stage 1: Discovery

Ask about the skill:

  • What problem does this skill solve?
  • What are the main capabilities?
  • What triggers should invoke it? (phrases users would say)
  • Where should it live? (personal, project, or plugin)
  • Is it for use within a Claude plugin? If so, load the /claude-craft and /claude-plugins skills.

Stage 2: Archetype Selection

ArchetypeUse WhenExample
simpleBasic skill without scriptsQuick reference, style guide
api-wrapperWrapping external APIsGitHub API, Stripe API
document-processorWorking with file formatsPDF extractor, Excel analyzer
dev-workflowAutomating development tasksGit workflow, project scaffolder
research-synthesizerGathering and synthesizing informationCompetitive analysis, literature review

Stage 3: Directory Structure

skill-name/
├── SKILL.md           # Required: instructions + metadata
├── scripts/           # Optional: executable code
├── references/        # Optional: documentation
└── assets/            # Optional: templates, resources

Stage 4: Frontmatter Schema

---
name: skill-name
description: "What it does and when to use it. Include trigger keywords."
version: 1.0.0                         # optional, recommended
license: Apache-2.0                    # optional
compatibility: Requires git and jq     # optional
metadata:                              # optional
  author: your-org
  category: development
  tags: [testing, automation]
---
FieldRequiredConstraints
nameYes2-64 chars, lowercase/numbers/hyphens, must match directory
descriptionYes10-1024 chars, quoted, describes what + when
versionNoSemantic version (MAJOR.MINOR.PATCH)
licenseNoLicense name or reference
compatibilityNo1-500 chars, environment requirements
metadataNoObject for custom fields

Important:

  • Always wrap description in double quotes — values containing colons, commas, or special characters can break YAML parsing otherwise.
  • Platform-specific fields (e.g., Claude's allowed-tools, user-invocable) should be added per-platform. Load the /claude-craft skill for Claude-specific fields.

Custom Frontmatter

Custom fields must be nested under metadata:

---
name: my-skill
description: "..."
metadata:
  author: your-org
  version: "1.0"
  category: development
  tags: [typescript, testing]
---

Top-level custom fields are not allowed and may cause parsing errors.

Description Formula

[WHAT] + [WHEN] + [TRIGGERS]

description: "Extracts text and tables from PDF files, fills forms, merges documents. Use when working with PDF files or document extraction."

Checklist:

  • Explains WHAT (capabilities)
  • States WHEN (trigger conditions)
  • Includes 3-5 trigger KEYWORDS
  • Uses third-person voice
  • Under 200 words

Stage 5: Validation

Validation Checklist

A. YAML Frontmatter

  • Opens with --- on line 1, closes with ---
  • name and description present (required)
  • description wrapped in double quotes
  • Uses spaces, not tabs
  • Special characters quoted

B. Naming

  • Lowercase, numbers, hyphens only (1-64 chars)
  • Matches parent directory name
  • No --, leading/trailing hyphens
  • No anthropic or claude in name
  • Does not collide with a built-in slash command

C. Description Quality

  • WHAT: Explains capabilities
  • WHEN: States "Use when..." conditions
  • TRIGGERS: 3-5 keywords users would say
  • Third-person voice (not "I can" or "you can")

D. Structure

  • SKILL.md under 500 lines
  • All referenced files exist
  • No TODO/placeholder markers
  • Progressive disclosure (details in references/)
  • No <bang>`command` preprocessing patterns (use <bang> instead of literal !)

Report Format

# Skill Check: {skill-name}

**Status**: PASS | WARNINGS | FAIL
**Issues**: {critical} critical, {warnings} warnings

## Critical (must fix)
1. {issue with fix}

## Warnings (should fix)
1. {issue with fix}

## Strengths
- {what's done well}

Core Principles

Concise is key

Context window is shared. Only include what the agent doesn't already know. Challenge each paragraph—does it justify its token cost?

Third-person descriptions

Descriptions inject into system prompt:

  • "Extracts text from PDFs"
  • "I can help you extract text from PDFs"

Progressive disclosure

Keep SKILL.md under 500 lines. Move details to:

  • references/ - Detailed docs, API references
  • scripts/ - Executable utilities (code never enters context)
  • assets/ - Templates, data files

Preprocessing safety

SKILL.md files are preprocessed by Claude Code — <bang>`command` syntax executes at load time, even inside code fences. When documenting this syntax in SKILL.md, use <bang> as a stand-in for !. Reference files and EXAMPLES.md are not preprocessed, so literal ! is safe there.

Skills that intentionally preprocess should declare metadata.preprocess: true. Run /skillcheck to lint for unintentional preprocessing patterns.

Token loading:

  1. Metadata (~100 tokens): name + description at startup
  2. Instructions (<5000 tokens): SKILL.md body when activated
  3. Resources (as needed): files loaded only when referenced

Degrees of freedom

Match instruction specificity to task requirements:

  • High freedom (text): Multiple valid approaches, use judgment
  • Medium freedom (pseudocode): Preferred pattern with variation allowed
  • Low freedom (scripts): Exact sequence required, no deviation

See patterns.md for detailed examples.

Naming Requirements

  • Lowercase letters, numbers, hyphens only
  • Cannot start/end with hyphen or contain --
  • Must match parent directory name
  • Cannot contain anthropic or claude
  • Must not collide with built-in slash commands (/help, /status, /config, /compact, /review, /model, /init, /login, /logout, /doctor, /clear, /mcp, /memory, /permissions, /terminal-setup, /vim, /cost, /bug). Built-in commands take precedence — a skill with a colliding name will be unreachable via slash invocation.

Recommended: Gerund form (processing-pdfs, reviewing-code)

Platform-Specific Guidance

Skills are cross-platform, but each tool has specific implementation details:

  • Claude Code: Load the /claude-craft skill for Claude-specific skill authoring
  • Codex CLI: See codex.md for discovery paths, $skill-name invocation

See implementations.md for storage paths and invocations.md for activation patterns.

References

External Resources

Install

Download ZIP
Requires askill CLI v1.0+

AI Quality Score

92/100Analyzed 2/19/2026

Highly comprehensive skill for creating and validating Agent Skills. Well-structured with clear stages, validation checklists, archetype selection, and frontmatter schemas. Excellent clarity and reusability as an open-specification meta-skill. Minor扣分 for path depth suggesting potential internal focus, but content is broadly applicable.

85
95
95
95
90

Metadata

Licenseunknown
Version-
Updated3 weeks ago
Publisheroutfitter-dev

Tags

apigithubgithub-actionslintingllmprompting