agentleFS
OneDro1dOneDro1d/dark-factory/skills/creating-skills/SKILL.md

creating-skills

Skill4 starsChanged 2 months agoApache-2.0View on GitHub

Create high-quality Claude Code skills with proper structure, effective descriptions, and best practices. Use when creating a new skill, writing SKILL.md files, setting up skill directories, or asking how to make skills.

30 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use building-chatgpt-apps, building-chat-interfaces and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • mjunaidcaSkill

    building-chatgpt-apps

    Guides creation of ChatGPT Apps with interactive widgets using OpenAI Apps SDK and MCP servers. Use when building ChatGPT custom apps with visual UI components, embedded widgets, or rich interactive experiences. Covers widget architecture, MCP server setup with FastMCP, response metadata, and Developer Mode configuration. NOT when building standard MCP servers without widgets (use building-mcp-servers skill instead).

    Also in 4 projects that use this

  • mjunaidcaSkill

    building-chat-interfaces

    Build AI chat interfaces with custom backends, authentication, and context injection. Use when integrating chat UI with AI agents, adding auth to chat, injecting user/page context, or implementing httpOnly cookie proxies. Covers ChatKitServer, useChatKit, and MCP auth patterns. NOT when building simple chatbots without persistence or custom agent integration.

    Also in 4 projects that use this

  • +10 more from mjunaidca

The file

We split this skill into the rules it gives an agent

7 rules. 0 are common, 4 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 28 edited versions we read keep these.

  • 4

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use allowed-tools to limit Claude's capabilities when the skill is active:

    line 117
  2. Distinctive:

    Read-only analysis (prevent accidental writes)

    line 131
  3. Very specific:

    Keep SKILL.md focused. Link to supporting files for detail:

    line 137
  4. Distinctive:

    Missing dependencies: - Document required packages

    line 158
  5. Distinctive:

    No examples: - Always include concrete usage

    line 159
  6. Very specific:

    Monolithic SKILL.md: - Use progressive disclosure for >500 lines

    line 160
  7. Distinctive:

    Use CHECKLIST.md to validate your skill before committing.

    line 165

“Common” is measured: kept by at least 6 in 10 of the 28 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Creating Claude Code Skills

A meta-skill for creating well-structured, discoverable, and effective Claude Code skills.

Overview

Claude Skills are markdown files that teach Claude specialized knowledge. They're automatically discovered based on their description, so writing effective descriptions is critical.

Quick Start

  1. Choose location based on scope:
    • Personal: ~/.claude/skills/your-skill/
    • Project: .claude/skills/your-skill/
  2. Create directory and SKILL.md:
    mkdir -p .claude/skills/your-skill
  3. Write SKILL.md with required frontmatter:
    ---
    name: your-skill-name
    description: [Trigger-rich description]
    ---
  4. Validate using CHECKLIST.md

The Golden Rule: Description Is Everything

Claude uses the description field to decide when to apply your skill. A poor description means your skill never triggers.

Description Formula

[What it does] + [Specific capabilities] + [Trigger phrases]

Bad vs Good Descriptions

BadGood
"Helps with testing""Write and run unit tests for TypeScript. Use when creating tests, mocking dependencies, or improving test coverage."
"Database helper""Generate SQL migrations and queries for PostgreSQL. Use when creating tables, writing queries, or migrating schemas."
"Code review""Review code for bugs, security issues, and style violations. Use when reviewing PRs, auditing code, or checking for vulnerabilities."

Skill Structure

Minimal (Single File)

your-skill/
└── SKILL.md

Standard (With Supporting Docs)

your-skill/
├── SKILL.md           # Overview + quick start (< 500 lines)
├── REFERENCE.md       # Detailed documentation
├── EXAMPLES.md        # Usage examples
└── CHECKLIST.md       # Validation checklist

Advanced (With Scripts)

your-skill/
├── SKILL.md
├── docs/
│   ├── api.md
│   └── patterns.md
└── scripts/
    ├── setup.sh       # Executed, not loaded as context
    └── validate.py

SKILL.md Template

See TEMPLATES.md for ready-to-use templates.

---
name: skill-name              # Lowercase, hyphens only (max 64 chars)
description: [description]    # Max 1024 chars - MOST IMPORTANT FIELD
allowed-tools: Read, Grep     # Optional - restrict tool access
---

# Skill Name

## Overview
[1-2 sentence summary of what this skill does]

## When to Use
[Specific scenarios, triggers, and use cases]

## Instructions
[Step-by-step guidance - numbered for clarity]

## Examples
[Concrete usage examples with expected outcomes]

## Resources
[Links to supporting files if applicable]

Tool Restrictions

Use allowed-tools to limit Claude's capabilities when the skill is active:

# Read-only skill
allowed-tools: Read, Grep, Glob

# Python automation only
allowed-tools: Bash(python:*)

# Multiple specific commands
allowed-tools: Read, Bash(git:*, npm:*, pnpm:*)

When to restrict:

  • Read-only analysis (prevent accidental writes)
  • Specific tooling (Python scripts, Git operations)
  • Security-sensitive workflows

Progressive Disclosure

Keep SKILL.md focused. Link to supporting files for detail:

## Quick Reference
[Essential info here]

## Detailed Documentation
For complete API reference, see [REFERENCE.md](REFERENCE.md).
For troubleshooting, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md).

Why it matters:

  • Claude loads SKILL.md first
  • Supporting files load on-demand
  • Keeps context focused for better performance
  • Scripts execute without consuming tokens

Common Mistakes to Avoid

  1. Vague descriptions - Include specific trigger keywords
  2. Too broad scope - One skill = one purpose
  3. Missing dependencies - Document required packages
  4. No examples - Always include concrete usage
  5. Monolithic SKILL.md - Use progressive disclosure for >500 lines
  6. Similar descriptions - Make each skill's description distinct

Quality Checklist

Use CHECKLIST.md to validate your skill before committing.

Examples

See EXAMPLES.md for complete, production-ready skill examples.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.