agentleFS
edisonzerolamedisonzerolam/openclaw-skills/qclaw-skill-creator/SKILL.md

qclaw-skill-creator

Skill0 starsChanged 4 months agoMITView on GitHub

Guide for creating effective skills. This skill should be used when users want to create a new skill (or update an existing skill) that extends Claude's capabilities with specialized knowledge, workflows, or tool integrations.

The file

Show its rules and text

We split this skill into the rules it gives an agent

26 rules. About 0 are common, 17 are distinctive, and 9 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈17

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 9

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Default assumption: Claude is already very smart: Only add context Claude doesn't already have.

    line 31
  2. Distinctive:

    Prefer concise examples over verbose explanations.

    line 33
  3. Distinctive:

    High freedom (text-based instructions): Use when multiple approaches are valid, decisions depend on context, or heuristics guide the …

    line 39
  4. Distinctive:

    Medium freedom (pseudocode or scripts with parameters): Use when a preferred pattern exists, some variation is acceptable, or configuration …

    line 41
  5. Distinctive:

    Low freedom (specific scripts, few parameters): Use when operations are fragile and error-prone, consistency is critical, or a specific …

    line 43
  6. Very specific:

    Every skill consists of a required SKILL.md file and optional bundled resources:

    line 49
  7. Very specific:

    Every SKILL.md consists of:

    line 67
  8. Distinctive:

    When to include: When the same code is being rewritten repeatedly or deterministic reliability is needed

    line 78
  9. Very specific:

    Best practice: If files are large (>10k words), include grep search patterns in SKILL.md

    line 91
  10. Distinctive:

    When to include: When the skill needs files that will be used in the final output

    line 98
  11. Distinctive:

    Metadata (name + description): - Always in context (~100 words)

    line 119
  12. Very specific:

    SKILL.md body: - When skill triggers (<5k words)

    line 120
  13. Very specific:

    Key principle: When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in …

    line 213
  14. Distinctive:

    When a user asks about sales metrics, Claude only reads sales.md.

    line 248
  15. Distinctive:

    When the user chooses AWS, Claude only reads aws.md.

    line 261
  16. Very specific:

    Avoid deeply nested references: - Keep references one level deep from SKILL.md.

    line 286
  17. Very specific:

    Creating a new skill MUST use scripts/init_skill.py: Do NOT manually create skill directories or SKILL.md files with mkdir, …

    line 291
  18. Distinctive:

    Follow these steps in order, skipping only if there is a clear reason why they are not applicable.

    line 318
  19. Very specific:

    After initialization, customize or remove the generated SKILL.md and example files as needed.

    line 391
  20. Distinctive:

    Writing Guidelines: Always use imperative/infinitive form.

    line 416
  21. Very specific:

    Write the YAML frontmatter with name and description:

    line 420
  22. Distinctive:

    Do not include any other fields in YAML frontmatter.

    line 428
  23. Distinctive:

    Write instructions for using the skill and its bundled resources.

    line 432
  24. Distinctive:

    If validation fails, the script will report the errors and exit without creating a package.

    line 459
  25. Distinctive:

    After testing the skill, users may request improvements.

    line 463
  26. Distinctive:

    Use the skill on real tasks

    line 467

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

Skill Creator

This skill provides guidance for creating effective skills.

About Skills

Skills are modular, self-contained packages that extend Claude's capabilities by providing specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific domains or tasks—they transform Claude from a general-purpose agent into a specialized agent equipped with procedural knowledge that no model can fully possess.

What Skills Provide

  1. Specialized workflows - Multi-step procedures for specific domains
  2. Tool integrations - Instructions for working with specific file formats or APIs
  3. Domain expertise - Company-specific knowledge, schemas, business logic
  4. Bundled resources - Scripts, references, and assets for complex and repetitive tasks

Core Principles

Concise is Key

The context window is a public good. Skills share the context window with everything else Claude needs: system prompt, conversation history, other Skills' metadata, and the actual user request.

Default assumption: Claude is already very smart. Only add context Claude doesn't already have. Challenge each piece of information: "Does Claude really need this explanation?" and "Does this paragraph justify its token cost?"

Prefer concise examples over verbose explanations.

Set Appropriate Degrees of Freedom

Match the level of specificity to the task's fragility and variability:

High freedom (text-based instructions): Use when multiple approaches are valid, decisions depend on context, or heuristics guide the approach.

Medium freedom (pseudocode or scripts with parameters): Use when a preferred pattern exists, some variation is acceptable, or configuration affects behavior.

Low freedom (specific scripts, few parameters): Use when operations are fragile and error-prone, consistency is critical, or a specific sequence must be followed.

Think of Claude as exploring a path: a narrow bridge with cliffs needs specific guardrails (low freedom), while an open field allows many routes (high freedom).

Anatomy of a Skill

Every skill consists of a required SKILL.md file and optional bundled resources:

skill-name/
├── SKILL.md (required)
│   ├── YAML frontmatter metadata (required)
│   │   ├── name: (required)
│   │   ├── description: (required)
│   │   └── compatibility: (optional, rarely needed)
│   └── Markdown instructions (required)
└── Bundled Resources (optional)
    ├── scripts/          - Executable code (Python/Bash/etc.)
    ├── references/       - Documentation intended to be loaded into context as needed
    └── assets/           - Files used in output (templates, icons, fonts, etc.)

SKILL.md (required)

Every SKILL.md consists of:

  • Frontmatter (YAML): Contains name and description fields (required), plus optional fields like license, metadata, and compatibility. Only name and description are read by Claude to determine when the skill triggers, so be clear and comprehensive about what the skill is and when it should be used. The compatibility field is for noting environment requirements (target product, system packages, etc.) but most skills don't need it.
  • Body (Markdown): Instructions and guidance for using the skill. Only loaded AFTER the skill triggers (if at all).

Bundled Resources (optional)

Scripts (scripts/)

Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.

  • When to include: When the same code is being rewritten repeatedly or deterministic reliability is needed
  • Example: scripts/rotate_pdf.py for PDF rotation tasks
  • Benefits: Token efficient, deterministic, may be executed without loading into context
  • Note: Scripts may still need to be read by Claude for patching or environment-specific adjustments
References (references/)

Documentation and reference material intended to be loaded as needed into context to inform Claude's process and thinking.

  • When to include: For documentation that Claude should reference while working
  • Examples: references/finance.md for financial schemas, references/mnda.md for company NDA template, references/policies.md for company policies, references/api_docs.md for API specifications
  • Use cases: Database schemas, API documentation, domain knowledge, company policies, detailed workflow guides
  • Benefits: Keeps SKILL.md lean, loaded only when Claude determines it's needed
  • Best practice: If files are large (>10k words), include grep search patterns in SKILL.md
  • Avoid duplication: Information should live in either SKILL.md or references files, not both. Prefer references files for detailed information unless it's truly core to the skill—this keeps SKILL.md lean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance in SKILL.md; move detailed reference material, schemas, and examples to references files.
Assets (assets/)

Files not intended to be loaded into context, but rather used within the output Claude produces.

  • When to include: When the skill needs files that will be used in the final output
  • Examples: assets/logo.png for brand assets, assets/slides.pptx for PowerPoint templates, assets/frontend-template/ for HTML/React boilerplate, assets/font.ttf for typography
  • Use cases: Templates, images, icons, boilerplate code, fonts, sample documents that get copied or modified
  • Benefits: Separates output resources from documentation, enables Claude to use files without loading them into context

What to Not Include in a Skill

A skill should only contain essential files that directly support its functionality. Do NOT create extraneous documentation or auxiliary files, including:

  • README.md
  • INSTALLATION_GUIDE.md
  • QUICK_REFERENCE.md
  • CHANGELOG.md
  • etc.

The skill should only contain the information needed for an AI agent to do the job at hand. It should not contain auxilary context about the process that went into creating it, setup and testing procedures, user-facing documentation, etc. Creating additional documentation files just adds clutter and confusion.

Progressive Disclosure Design Principle

Skills use a three-level loading system to manage context efficiently:

  1. Metadata (name + description) - Always in context (~100 words)
  2. SKILL.md body - When skill triggers (<5k words)
  3. Bundled resources - As needed by Claude (Unlimited because scripts can be executed without reading into context window)

🧠 四硬核工程原则(Anthropic 官方 Engineering Blog 蒸馏)

原文:《Equipping agents for the real world with Agent Skills》 Barry Zhang / Keith Lazuka / Mahesh Murag, Anthropic Engineering, 2025-10-16

这四条不是软提示,是硬约束。每条对应原文确切出处。

① 描述 = 路由器,不是简介

原文强调 description 是 Skill 唯一的触发决策依据——所有 Skill 的 name+description 在 Agent 启动时全量常驻 system prompt,Claude 用文本相似度匹配来决定触发谁。

硬规则:

  • ❌ "A comprehensive skill for data analysis" → 太宽泛,谁都能触发
  • ✅ "Use when user asks to sort/filter/aggregate CSV or JSON data, especially multi-file batch operations. NOT for SQL queries or pandas dataframe manipulation."
  • 必须包含三要素:触发场景 + 关键动词 + 反例边界(什么情况不触发)
  • name 必须 ≤ 64 字符,动词优先("sort-data" > "data-sorting-utility")

② 渐进式披露的三层必须清晰

原文三层加载模型:

层级什么内容加载时机容量红线
L1 路由层YAML frontmatter (name+description)Agent 启动全量常驻≤ 1 段 / ~300 token
L2 主说明层SKILL.md 正文Skill 触发后加载≤ 200 行 / ~5k token
L3 资源层额外 .md / .py / 数据文件触发后按需点开无限(不占 context window)

工程要点:

  • L2 超过 200 行 → 必须拆文件。互斥场景的章节必须拆到不同文件,避免一次性占满 context
  • L3 文件名必须自解释(forms.md / reference/aws.md / scripts/rotate_pdf.py),禁止纯数字编号
  • code 同时是"工具"+"文档":在 description 里必须写清 Agent 该跑脚本还是读文件

③ 从缺口出发,不从蓝图出发

原文第一条开发实践 —— "Start with evaluation":

"Identify specific gaps in your agents' capabilities by running them on representative tasks and observing where they struggle or require additional context. Then build skills incrementally to address these shortcomings."

正确流程:

  1. 跑 3-5 个真实任务,记下"哪里卡 / 哪里需要补上下文"
  2. 只针对缺口建 Skill
  3. 每次改动都要能回答:"这个 Skill 修好了哪一类具体的失败?"

反模式: 拍脑袋"我要做个项目管理大 Skill"然后一次性写完。原文反复强调:

"Keep it focused. Multiple focused skills compose better than one large skill."

④ 确定性步骤必须用脚本兜底

原文硬话:

"Certain operations are better suited for traditional code execution... Many applications require the deterministic reliability that only code can provide."

这条没有商量余地:

  • 排序 / 校验 / 数值 / 格式转换 / 正则匹配 → 立刻写脚本,不让 LLM 用 token 推理
  • 判断 / 解释 / 规划 / 文案 → 留给 LLM
  • 每个脚本在 SKILL.md 里显式标注:"run scripts/X.py" 还是 "read scripts/X.py as reference"

例(PDF Skill,原文案例):

  • Python 脚本提取 PDF 所有表单字段(确定性)→ Claude 语义判断怎么填(LLM 判断)
  • 这条是生产级 Agent 的硬门槛:靠 Prompt 做质量检查 = 不可能上生产

补充:原文还有两条容易被忽略的要求

⑤ 安全审计:Skill 含可执行代码 = 信任边界。只装可信源,三方 Skill 装前必须审计所有文件和依赖。

⑥ 跨产品通用:用 agentskills.io 开放标准,同一格式在 Claude.ai / Claude Code / API / Agent SDK 通用。


Progressive Disclosure Patterns

Keep SKILL.md body to the essentials and under 500 lines to minimize context bloat. Split content into separate files when approaching this limit. When splitting out content into other files, it is very important to reference them from SKILL.md and describe clearly when to read them, to ensure the reader of the skill knows they exist and when to use them.

Key principle: When a skill supports multiple variations, frameworks, or options, keep only the core workflow and selection guidance in SKILL.md. Move variant-specific details (patterns, examples, configuration) into separate reference files.

Pattern 1: High-level guide with references

# PDF Processing

## Quick start

Extract text with pdfplumber:
[code example]

## Advanced features

- **Form filling**: See [FORMS.md](FORMS.md) for complete guide
- **API reference**: See [REFERENCE.md](REFERENCE.md) for all methods
- **Examples**: See [EXAMPLES.md](EXAMPLES.md) for common patterns

Claude loads FORMS.md, REFERENCE.md, or EXAMPLES.md only when needed.

Pattern 2: Domain-specific organization

For Skills with multiple domains, organize content by domain to avoid loading irrelevant context:

bigquery-skill/
├── SKILL.md (overview and navigation)
└── reference/
    ├── finance.md (revenue, billing metrics)
    ├── sales.md (opportunities, pipeline)
    ├── product.md (API usage, features)
    └── marketing.md (campaigns, attribution)

When a user asks about sales metrics, Claude only reads sales.md.

Similarly, for skills supporting multiple frameworks or variants, organize by variant:

cloud-deploy/
├── SKILL.md (workflow + provider selection)
└── references/
    ├── aws.md (AWS deployment patterns)
    ├── gcp.md (GCP deployment patterns)
    └── azure.md (Azure deployment patterns)

When the user chooses AWS, Claude only reads aws.md.

Pattern 3: Conditional details

Show basic content, link to advanced content:

# DOCX Processing

## Creating documents

Use docx-js for new documents. See [DOCX-JS.md](DOCX-JS.md).

## Editing documents

For simple edits, modify the XML directly.

**For tracked changes**: See [REDLINING.md](REDLINING.md)
**For OOXML details**: See [OOXML.md](OOXML.md)

Claude reads REDLINING.md or OOXML.md only when the user needs those features.

Important guidelines:

  • Avoid deeply nested references - Keep references one level deep from SKILL.md. All reference files should link directly from SKILL.md.
  • Structure longer reference files - For files longer than 100 lines, include a table of contents at the top so Claude can see the full scope when previewing.

⚠️ MANDATORY: Use init_skill.py — No Manual Creation

Creating a new skill MUST use scripts/init_skill.py. Do NOT manually create skill directories or SKILL.md files with mkdir, write_to_file, or any other method.

# The ONLY correct way to create a new skill:
scripts/init_skill.py <skill-name> --path ~/.qclaw/skills
# Windows:
python scripts\init_skill.py <skill-name> --path %USERPROFILE%\.qclaw\skills
  • ✅ Correct: Run scripts/init_skill.py news-paper-test --path ~/.qclaw/skills → creates ~/.qclaw/skills/news-paper-test/
  • ❌ FORBIDDEN: Manually writing files to ~/.qclaw/skills/ or any other path
  • ❌ FORBIDDEN: Using mkdir + write_to_file to create skill structure
  • ❌ FORBIDDEN: Writing to ~/.qclaw/workspace/... or resources/openclaw/config/skills/...

The script handles directory creation, path validation, and template generation. Manual creation bypasses these safeguards and leads to incorrect paths. No exceptions.

Skill Creation Process

Skill creation involves these steps:

  1. Understand the skill with concrete examples
  2. Plan reusable skill contents (scripts, references, assets)
  3. Initialize the skill (run init_skill.py)
  4. Edit the skill (implement resources and write SKILL.md)
  5. Package the skill (run package_skill.py)
  6. Iterate based on real usage

Follow these steps in order, skipping only if there is a clear reason why they are not applicable.

Step 1: Understanding the Skill with Concrete Examples

Skip this step only when the skill's usage patterns are already clearly understood. It remains valuable even when working with an existing skill.

To create an effective skill, clearly understand concrete examples of how the skill will be used. This understanding can come from either direct user examples or generated examples that are validated with user feedback.

For example, when building an image-editor skill, relevant questions include:

  • "What functionality should the image-editor skill support? Editing, rotating, anything else?"
  • "Can you give some examples of how this skill would be used?"
  • "I can imagine users asking for things like 'Remove the red-eye from this image' or 'Rotate this image'. Are there other ways you imagine this skill being used?"
  • "What would a user say that should trigger this skill?"

To avoid overwhelming users, avoid asking too many questions in a single message. Start with the most important questions and follow up as needed for better effectiveness.

Conclude this step when there is a clear sense of the functionality the skill should support.

Step 2: Planning the Reusable Skill Contents

To turn concrete examples into an effective skill, analyze each example by:

  1. Considering how to execute on the example from scratch
  2. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly

Example: When building a pdf-editor skill to handle queries like "Help me rotate this PDF," the analysis shows:

  1. Rotating a PDF requires re-writing the same code each time
  2. A scripts/rotate_pdf.py script would be helpful to store in the skill

Example: When designing a frontend-webapp-builder skill for queries like "Build me a todo app" or "Build me a dashboard to track my steps," the analysis shows:

  1. Writing a frontend webapp requires the same boilerplate HTML/React each time
  2. An assets/hello-world/ template containing the boilerplate HTML/React project files would be helpful to store in the skill

Example: When building a big-query skill to handle queries like "How many users have logged in today?" the analysis shows:

  1. Querying BigQuery requires re-discovering the table schemas and relationships each time
  2. A references/schema.md file documenting the table schemas would be helpful to store in the skill

To establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.

Step 3: Initializing the Skill

At this point, it is time to actually create the skill.

Skip this step only if the skill being developed already exists, and iteration or packaging is needed. In this case, continue to the next step.

MANDATORY: You MUST run init_skill.py to create the skill directory and template files. Do NOT manually create directories or write SKILL.md files yourself. The script ensures correct path, directory structure, and template format.

Usage:

scripts/init_skill.py <skill-name> --path ~/.qclaw/skills

On Windows:

python scripts\init_skill.py <skill-name> --path %USERPROFILE%\.qclaw\skills

CRITICAL: The --path MUST be set to ~/.qclaw/skills (Windows: %USERPROFILE%\.qclaw\skills). This ensures user-created skills persist across application updates. Example: scripts/init_skill.py say-hi --path ~/.qclaw/skills creates ~/.qclaw/skills/say-hi/.

NEVER create skills in the application's bundled skills directory (e.g., resources/openclaw/config/skills/ or any path containing openclaw/config/skills). That directory is reserved for built-in skills shipped with the application and is completely replaced during updates — any user-created skills placed there will be permanently lost.

The script:

  • Creates the skill directory at the specified path
  • Generates a SKILL.md template with proper frontmatter and TODO placeholders
  • Creates example resource directories: scripts/, references/, and assets/
  • Adds example files in each directory that can be customized or deleted

After initialization, customize or remove the generated SKILL.md and example files as needed.

Step 4: Edit the Skill

When editing the (newly-generated or existing) skill, remember that the skill is being created for another instance of Claude to use. Include information that would be beneficial and non-obvious to Claude. Consider what procedural knowledge, domain-specific details, or reusable assets would help another Claude instance execute these tasks more effectively.

Learn Proven Design Patterns

Consult these helpful guides based on your skill's needs:

  • Multi-step processes: See references/workflows.md for sequential workflows and conditional logic
  • Specific output formats or quality standards: See references/output-patterns.md for template and example patterns

These files contain established best practices for effective skill design.

Start with Reusable Skill Contents

To begin implementation, start with the reusable resources identified above: scripts/, references/, and assets/ files. Note that this step may require user input. For example, when implementing a brand-guidelines skill, the user may need to provide brand assets or templates to store in assets/, or documentation to store in references/.

Added scripts must be tested by actually running them to ensure there are no bugs and that the output matches what is expected. If there are many similar scripts, only a representative sample needs to be tested to ensure confidence that they all work while balancing time to completion.

Any example files and directories not needed for the skill should be deleted. The initialization script creates example files in scripts/, references/, and assets/ to demonstrate structure, but most skills won't need all of them.

Update SKILL.md

Writing Guidelines: Always use imperative/infinitive form.

Frontmatter

Write the YAML frontmatter with name and description:

  • name: The skill name
  • description: This is the primary triggering mechanism for your skill, and helps Claude understand when to use the skill.
    • Include both what the Skill does and specific triggers/contexts for when to use it.
    • Include all "when to use" information here - Not in the body. The body is only loaded after triggering, so "When to Use This Skill" sections in the body are not helpful to Claude.
    • Example description for a docx skill: "Comprehensive document creation, editing, and analysis with support for tracked changes, comments, formatting preservation, and text extraction. Use when Claude needs to work with professional documents (.docx files) for: (1) Creating new documents, (2) Modifying or editing content, (3) Working with tracked changes, (4) Adding comments, or any other document tasks"

Do not include any other fields in YAML frontmatter.

Body

Write instructions for using the skill and its bundled resources.

Step 5: Packaging a Skill

Once development of the skill is complete, it must be packaged into a distributable .skill file that gets shared with the user. The packaging process automatically validates the skill first to ensure it meets all requirements:

scripts/package_skill.py <path/to/skill-folder>

Optional output directory specification:

scripts/package_skill.py <path/to/skill-folder> ./dist

The packaging script will:

  1. Validate the skill automatically, checking:

    • YAML frontmatter format and required fields
    • Skill naming conventions and directory structure
    • Description completeness and quality
    • File organization and resource references
  2. Package the skill if validation passes, creating a .skill file named after the skill (e.g., my-skill.skill) that includes all files and maintains the proper directory structure for distribution. The .skill file is a zip file with a .skill extension.

If validation fails, the script will report the errors and exit without creating a package. Fix any validation errors and run the packaging command again.

Step 6: Iterate

After testing the skill, users may request improvements. Often this happens right after using the skill, with fresh context of how the skill performed.

Iteration workflow:

  1. Use the skill on real tasks
  2. Notice struggles or inefficiencies
  3. Identify how SKILL.md or bundled resources should be updated
  4. Implement changes and test again

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.