
Skill Creator
- 327 installs
- 2.2k repo stars
- Updated April 3, 2026
- mrgoonie/claudekit-skills
skill-creator is a Claude Code meta-skill that guides developers through authoring, validating, and packaging agent skills with triggers, bundled resources, and progressive-disclosure workflows.
About
skill-creator is a Claude Code meta-skill (version 2.0.0) from mrgoonie/claudekit-skills that walks developers through the full skill authoring lifecycle. The skill explains the SKILL.md anatomy—YAML frontmatter under 200 characters, a body kept under 150 lines, and optional scripts/, references/, and assets/ folders loaded via progressive disclosure. It prescribes a six-step creation process covering example gathering, internet research, reusable resource planning, init_skill.py scaffolding, SKILL.md editing, and package_skill.py validation before zip distribution. Developers reach for skill-creator when they need repeatable agent capabilities—API integrations, domain workflows, or packaged CLI scripts—that Claude should auto-trigger from metadata descriptions. The skill also documents plugin marketplace distribution and links five validation-criteria reference files plus marketplace hosting guides for teams shipping skills beyond a single repository.
- SKILL.md authoring patterns
- Trigger and scope design
- Bundled scripts and references
- Reusable agent capabilities
Skill Creator by the numbers
- 327 all-time installs (skills.sh)
- +3 installs in the week ending Jul 26, 2026 (Skillselion tracking)
- Ranked #131 of 781 Skill Development skills by installs in the Skillselion catalog
- Data as of Aug 3, 2026 (Skillselion catalog sync)
npx skills add https://github.com/mrgoonie/claudekit-skills --skill skill-creatorAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 327 |
|---|---|
| repo stars | ★ 2.2k |
| Last updated | April 3, 2026 |
| Repository | mrgoonie/claudekit-skills ↗ |
How do you author a Claude Code SKILL.md skill?
Author, structure, and package Claude Code skills with triggers, resources, and workflows so agents reliably invoke specialized capabilities across projects.
Who is it for?
Developers building reusable Claude Code skills who want structured scaffolding, validation scripts, and progressive-disclosure packaging conventions.
Skip if: Developers who only need one-off prompts without reusable SKILL.md triggers, bundled scripts, or distributable skill packages.
When should I use this skill?
User asks to create, update, package, or optimize a Claude Code skill with SKILL.md, triggers, references, or marketplace distribution.
What you get
Validated SKILL.md, references/ and scripts/ folders, packaged skill zip, and marketplace-ready plugin metadata.
- SKILL.md with frontmatter
- Packaged skill zip
- scripts/ and references/ folders
By the numbers
- skill-creator version 2.0.0
- SKILL.md body must stay under 150 lines
- Bundles 5 validation-criteria reference files
Files
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.
IMPORTANT:
- Skills are not documentation, they are practical instructions for Claude Code to use the tools, packages, plugins or APIs to achieve the tasks.
- Each skill teaches Claude how to perform a specific development task, not what a tool does.
- Claude Code can activate multiple skills automatically to achieve the user's request.
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
Anatomy of a Skill
Every skill consists of a required SKILL.md file and optional bundled resources:
.claude/skills/
└── skill-name/
├── SKILL.md (required)
│ ├── YAML frontmatter metadata (required)
│ │ ├── name: (required)
│ │ ├── description: (required)
│ │ ├── license: (optional)
│ │ └── version: (optional)
│ └── 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.)Requirements (IMPORTANT)
- Skill should be combined into specific topics, for example:
cloudflare,cloudflare-r2,cloudflare-workers,docker,gcloudshould be combined intodevops SKILL.mdshould be less than 150 lines and include the references of related markdown files and scripts.- Each script or referenced markdown file should be also less than 150 lines, remember that you can always split them into multiple files (progressive disclosure principle).
- Descriptions in metadata of
SKILL.mdfiles should be both concise (less than 200 characters) and still contains enough usecases of the references and scripts, this will help skills can be activated automatically during the implementation process of Claude Code. - Referenced markdowns:
- Sacrifice grammar for the sake of concision when writing these files.
- Can reference other markdown files or scripts as well.
- Referenced scripts:
- Prefer nodejs or python scripts instead of bash script, because bash scripts are not well-supported on Windows.
- If you're going to write python scripts, make sure you have
requirements.txt - Make sure scripts respect
.envfile follow this order:process.env>$HOME/.claude/skills/${SKILL}/.env(global) >$HOME/.claude/skills/.env(global) >$HOME/.claude/.env(global) >./.claude/skills/${SKILL}/.env(cwd) >./.claude/skills/.env(cwd) >./.claude/.env(cwd) - Create
.env.examplefiles to show the required environment variables. - Always write tests for these scripts.
IMPORTANT:
- Always keep in mind that
SKILL.mdand reference files should be token consumption efficient, so that progressive disclosure can be leveraged at best. SKILL.mdshould be less than 150 lines- Referenced markdown files should be also less than 150 lines, remember that you can always split them into multiple files (progressive disclosure principle).
- Referenced scripts: no limit on length, just make sure it works, no compile issues, no runtime issues, no dependencies issues, no environment issues, no platform issues.
Why? Better context engineering: leverage progressive disclosure technique of Agent Skills, when agent skills are activated, Claude Code will consider to load only relevant files into the context, instead of reading all long SKILL.md as before.
SKILL.md (required)
File name: SKILL.md (uppercase) File size: Under 150 lines, if you need more, split it to multiple files (<150 lines each) in references folder. SKILL.md is always short and concise, straight to the point, treat it as a quick reference guide.
Metadata Quality: The name and description (MUST be under 200 characters) in YAML frontmatter determine when Claude will use the skill. Be specific about what the skill does and when to use it, DO NOT sound generic, vague or educational. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
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.pyfor 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
IMPORTANT:
- Write tests for scripts.
- Run tests and make sure it works, if tests fail, fix them and run tests again, repeat until tests pass.
- Run scripts manually with some usecases to make sure it works.
- Make sure scripts respect
.envfile follow this order:process.env>$HOME/.claude/skills/${SKILL}/.env(global) >$HOME/.claude/skills/.env(global) >$HOME/.claude/.env(global) >./.claude/skills/${SKILL}/.env(cwd) >./.claude/skills/.env(cwd) >./.claude/.env(cwd)
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.mdfor financial schemas,references/mnda.mdfor company NDA template,references/policies.mdfor company policies,references/api_docs.mdfor API specifications - Use cases: Database schemas, best practices, common workflows, cheatsheets, tool instructions, API documentation, domain knowledge, company policies, detailed workflow guides
- Benefits: Keeps SKILL.md lean, loaded only when Claude determines it's needed, makes information discoverable without hogging the context window.
- Best practice: If files are large (>150 lines), split them into multiple files (<150 lines each) in
referencesfolder, include grep search patterns inSKILL.md - Avoid duplication: Information should live in either
SKILL.mdorreferencesfiles, not both. Preferreferencesfiles for detailed information unless it's truly core to the skill—this keepsSKILL.mdlean while making information discoverable without hogging the context window. Keep only essential procedural instructions and workflow guidance inSKILL.md; move detailed reference material, schemas, and examples toreferencesfiles.
IMPORTANT:
- Referenced markdown files should be also less than 150 lines, remember that you can always split them into multiple files (progressive disclosure principle).
- Referenced markdown files are practical instructions for Claude Code to use the tools, packages, plugins or APIs to achieve the tasks.
- Each skill teaches Claude how to perform a specific development task, not what a tool does.
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.pngfor brand assets,assets/slides.pptxfor PowerPoint templates,assets/frontend-template/for HTML/React boilerplate,assets/font.ttffor 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
Progressive Disclosure Design Principle
Skills use a three-level loading system to manage context efficiently:
1. Metadata (name + description) - Always in context (less than 200 characters) 2. SKILL.md body - When skill triggers (<5k words) 3. Bundled resources - As needed by Claude (Unlimited*)
*Unlimited because scripts can be executed without reading into context window.
Skill Creation Process
To create a skill, follow the "Skill Creation Process" in order, skipping steps 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.
Use AskUserQuestion tool to gather user feedback and validate understanding.
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: Research on The Internet
An effective skill is a subset of real-life workflows from professional workflows and case studies, so it's important to research on the internet to understand the current state of the art and best practices.
Activate /docs-seeker skill to search for documentation if needed.
If you receive a lot of URLs or files, use multiple WebFetch tools and Explore subagents to explore them in parallel, then report back to main agent.
Activate /research skill to research for:
- Best practices & industry standards
- Existing CLI tools (executable via
npx,bunxorpipx) and their usage patterns - Workflows & success case studies
- Common patterns, use cases & examples
- Edge cases, potential pitfalls & avoidance strategies
Write down the reports from the research to be used in the next step.
Step 3: 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. Prefer existing CLI tools' execution (via npx, bunx or pipx) over writing custom code 3. Identifying what scripts, references, and assets would be helpful when executing these workflows repeatedly 4. Analyze the current skills catalog to avoid duplicating functionality, re-using existing skills where possible.
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.
- Make sure scripts respect
.envfile follow this order:process.env>$HOME/.claude/skills/${SKILL}/.env(global) >$HOME/.claude/skills/.env(global) >$HOME/.claude/.env(global) >./.claude/skills/${SKILL}/.env(cwd) >./.claude/skills/.env(cwd) >./.claude/.env(cwd) - Make sure scripts have tests, run all tests and ensure they pass. DO NOT SKIP THIS STEP.
Step 4: 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.
When creating a new skill from scratch, always run the init_skill.py script. The script conveniently generates a new template skill directory that automatically includes everything a skill requires, making the skill creation process much more efficient and reliable.
Usage:
scripts/init_skill.py <skill-name> --path <output-directory>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/, andassets/ - 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 5: 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. Focus on including 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.
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/.
Also, delete any example files and directories not needed for the skill. 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 Style: Write the entire skill using imperative/infinitive form (verb-first instructions), not second person. Use objective, instructional language (e.g., "To accomplish X, do Y" rather than "You should do X" or "If you need to do X"). This maintains consistency and clarity for AI consumption.
To complete SKILL.md, answer the following questions:
1. What is the purpose of the skill, in a few sentences? 2. When should the skill be used? 3. In practice, how should Claude use the skill? All reusable skill contents developed above should be referenced so that Claude knows how to use them.
Step 5: Packaging a Skill
Once the skill is ready, it should be packaged into a distributable zip 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> ./distThe 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 (MUST be under 200 characters)
- File organization and resource references
2. Package the skill if validation passes, creating a zip file named after the skill (e.g., my-skill.zip) that includes all files and maintains the proper directory structure for distribution.
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. Notice token usage and performance 4. Identify how SKILL.md or bundled resources should be updated 5. Implement changes and test again
Validation Criteria
Detailed validation criteria for evaluating skills:
- Quick checklist:
references/validation-checklist.md - Metadata quality:
references/metadata-quality-criteria.md - Token efficiency:
references/token-efficiency-criteria.md - Script quality:
references/script-quality-criteria.md - Structure & organization:
references/structure-organization-criteria.md
Plugin Marketplaces
For distributing skills as plugins via marketplaces, see:
- Overview:
references/plugin-marketplace-overview.md - Schema:
references/plugin-marketplace-schema.md - Sources:
references/plugin-marketplace-sources.md - Hosting:
references/plugin-marketplace-hosting.md - Troubleshooting:
references/plugin-marketplace-troubleshooting.md
References
- Agent Skills
- Agent Skills Spec
- Agent Skills Overview
- Best Practices
- Plugin Marketplaces
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.Metadata Quality Criteria
Metadata determines when Claude activates the skill. Poor metadata = wrong activation or missed activation.
Name Field
Format: kebab-case, lowercase
Good Examples:
pdf-editor- clear domainbigquery-analyst- tool + rolefrontend-webapp-builder- specific function
Bad Examples:
helper- too genericmySkill- wrong casepdf- too short, unclear purpose
Description Field
Constraint: Under 200 characters
Purpose: Trigger automatic activation during implementation
Good Descriptions
Specific, action-oriented, includes use cases:
description: Build React/TypeScript frontends with modern patterns. Use for components, Suspense, lazy loading, performance optimization.description: Process PDFs with rotation, splitting, merging. Use for document manipulation, page extraction, PDF conversion.Bad Descriptions
Too generic or educational:
description: A skill for working with databases. # Too vaguedescription: This skill helps you understand how React works. # Educational, not actionableTrigger Precision
Description should answer: "What phrases would a user say that should trigger this skill?"
Example for `image-editor` skill:
- "Remove red-eye from this image"
- "Rotate this photo 90 degrees"
- "Crop the background out"
Include these trigger phrases/actions in description.
Third-Person Style
Correct: "This skill should be used when..." Wrong: "Use this skill when..." or "You should use this..."
Validation
Check with packaging script:
scripts/package_skill.py <skill-path>Fails if:
- Missing name or description
- Description exceeds 200 characters
- Invalid YAML syntax
Plugin Marketplace Hosting & Distribution
GitHub (Recommended)
1. Create repository for marketplace 2. Add .claude-plugin/marketplace.json with plugin definitions 3. Share: users add with /plugin marketplace add owner/repo
Benefits: Built-in version control, issue tracking, team collaboration.
Other Git Services
GitLab, Bitbucket, self-hosted servers all work:
/plugin marketplace add https://gitlab.com/company/plugins.gitPrivate Repositories
Manual Installation/Updates
Claude Code uses existing git credential helpers. If git clone works in terminal, it works in Claude Code.
Common credential helpers:
gh auth loginfor GitHub- macOS Keychain
git-credential-store
Background Auto-Updates
Set authentication token in environment:
| Provider | Environment Variables | Notes |
|---|---|---|
| GitHub | GITHUB_TOKEN or GH_TOKEN | Personal or GitHub App token |
| GitLab | GITLAB_TOKEN or GL_TOKEN | Personal or project token |
| Bitbucket | BITBUCKET_TOKEN | App password or repo token |
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxxRequire Marketplaces for Team
Add to .claude/settings.json:
{
"extraKnownMarketplaces": {
"company-tools": {
"source": {
"source": "github",
"repo": "your-org/claude-plugins"
}
}
},
"enabledPlugins": {
"code-formatter@company-tools": true,
"deployment-tools@company-tools": true
}
}Managed Marketplace Restrictions
Admins use strictKnownMarketplaces in managed settings:
| Value | Behavior |
|---|---|
| Undefined (default) | No restrictions, users can add any |
Empty array [] | Complete lockdown, no new marketplaces |
| List of sources | Users can only add from allowlist |
Allow Specific Marketplaces Only
{
"strictKnownMarketplaces": [
{ "source": "github", "repo": "acme-corp/approved-plugins" },
{ "source": "url", "url": "https://plugins.example.com/marketplace.json" }
]
}Allow All from Internal Server (Regex)
{
"strictKnownMarketplaces": [
{ "source": "hostPattern", "hostPattern": "^github\\.example\\.com$" }
]
}Test Locally Before Distribution
/plugin marketplace add ./my-local-marketplace
/plugin install test-plugin@my-local-marketplacePlugin Marketplace Overview
Build and host plugin marketplaces to distribute Claude Code extensions across teams and communities.
What is a Plugin Marketplace
A plugin marketplace is a catalog that lets you distribute plugins to others. Marketplaces provide:
- Centralized discovery
- Version tracking
- Automatic updates
- Support for multiple source types (git repositories, local paths, etc.)
Creating & Distributing a Marketplace
1. Create plugins: Build plugins with commands, agents, hooks, MCP servers, or LSP servers 2. Create marketplace file: Define marketplace.json listing plugins and sources 3. Host the marketplace: Push to GitHub, GitLab, or another git host 4. Share with users: Users add with /plugin marketplace add and install individual plugins
Directory Structure
my-marketplace/
├── .claude-plugin/
│ └── marketplace.json # Required: marketplace catalog
└── plugins/
└── my-plugin/
├── .claude-plugin/
│ └── plugin.json # Plugin manifest
└── skills/
└── my-skill/
└── SKILL.mdMarketplace File Location
Create .claude-plugin/marketplace.json in repository root.
User Commands
- Add marketplace:
/plugin marketplace add owner/repoor/plugin marketplace add ./local-path - Install plugin:
/plugin install plugin-name@marketplace-name - Update marketplace:
/plugin marketplace update - Validate:
/plugin validate .orclaude plugin validate .
Related References
- Schema details:
references/plugin-marketplace-schema.md - Plugin sources:
references/plugin-marketplace-sources.md - Hosting & distribution:
references/plugin-marketplace-hosting.md - Troubleshooting:
references/plugin-marketplace-troubleshooting.md
Official Documentation
https://code.claude.com/docs/en/plugin-marketplaces.md
Plugin Marketplace Schema
Marketplace JSON Structure
{
"name": "company-tools",
"owner": {
"name": "DevTools Team",
"email": "devtools@example.com"
},
"metadata": {
"description": "Brief marketplace description",
"version": "1.0.0",
"pluginRoot": "./plugins"
},
"plugins": [...]
}Required Fields
| Field | Type | Description | Example |
|---|---|---|---|
name | string | Marketplace identifier (kebab-case) | "acme-tools" |
owner | object | Maintainer info (name required, email optional) | |
plugins | array | List of available plugins |
Reserved Names
Cannot use: claude-code-marketplace, claude-code-plugins, claude-plugins-official, anthropic-marketplace, anthropic-plugins, agent-skills, life-sciences. Names impersonating official marketplaces also blocked.
Optional Metadata
| Field | Type | Description |
|---|---|---|
metadata.description | string | Brief marketplace description |
metadata.version | string | Marketplace version |
metadata.pluginRoot | string | Base directory for relative plugin source paths |
Plugin Entry Schema
Required Plugin Fields
| Field | Type | Description |
|---|---|---|
name | string | Plugin identifier (kebab-case) |
source | string\ | object |
Optional Plugin Fields
| Field | Type | Description |
|---|---|---|
description | string | Brief plugin description |
version | string | Plugin version |
author | object | Plugin author (name required, email optional) |
homepage | string | Plugin homepage or docs URL |
repository | string | Source code repository URL |
license | string | SPDX license identifier (MIT, Apache-2.0, etc.) |
keywords | array | Tags for discovery and categorization |
category | string | Plugin category for organization |
tags | array | Tags for searchability |
strict | boolean | If true (default), plugin needs own plugin.json |
Component Configuration Fields
| Field | Type | Description |
|---|---|---|
commands | string\ | array |
agents | string\ | array |
hooks | string\ | object |
mcpServers | string\ | object |
lspServers | string\ | object |
Example Plugin Entry
{
"name": "code-formatter",
"source": "./plugins/formatter",
"description": "Automatic code formatting on save",
"version": "2.1.0",
"author": { "name": "DevTools Team" },
"license": "MIT",
"keywords": ["formatting", "linting"],
"strict": false
}Plugin Marketplace Sources
Source Types
Relative Paths (Local)
For plugins in same repository:
{
"name": "my-plugin",
"source": "./plugins/my-plugin"
}Note: Relative paths only work when users add marketplace via Git. For URL-based distribution, use GitHub, npm, or git URL sources.
GitHub Repositories
{
"name": "github-plugin",
"source": {
"source": "github",
"repo": "owner/plugin-repo"
}
}Pin to specific branch, tag, or commit:
{
"name": "github-plugin",
"source": {
"source": "github",
"repo": "owner/plugin-repo",
"ref": "v2.0.0",
"sha": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"
}
}| Field | Type | Description |
|---|---|---|
repo | string | Required. GitHub repo in owner/repo format |
ref | string | Optional. Git branch or tag |
sha | string | Optional. Full 40-char git commit SHA |
Git Repositories (GitLab, Bitbucket, etc.)
{
"name": "git-plugin",
"source": {
"source": "url",
"url": "https://gitlab.com/team/plugin.git"
}
}| Field | Type | Description |
|---|---|---|
url | string | Required. Full git URL (must end with .git) |
ref | string | Optional. Git branch or tag |
sha | string | Optional. Full 40-char git commit SHA |
Advanced Plugin Entry Example
{
"name": "enterprise-tools",
"source": {
"source": "github",
"repo": "company/enterprise-plugin"
},
"description": "Enterprise workflow automation tools",
"version": "2.1.0",
"commands": [
"./commands/core/",
"./commands/enterprise/"
],
"agents": ["./agents/security-reviewer.md"],
"hooks": {
"PostToolUse": [{
"matcher": "Write|Edit",
"hooks": [{
"type": "command",
"command": "${CLAUDE_PLUGIN_ROOT}/scripts/validate.sh"
}]
}]
},
"mcpServers": {
"enterprise-db": {
"command": "${CLAUDE_PLUGIN_ROOT}/servers/db-server",
"args": ["--config", "${CLAUDE_PLUGIN_ROOT}/config.json"]
}
},
"strict": false
}Key variable: ${CLAUDE_PLUGIN_ROOT} - Use in hooks and MCP configs to reference files within plugin's installation directory (plugins are copied to cache when installed).
Plugin Marketplace Troubleshooting
Marketplace Not Loading
Symptoms: Can't add marketplace or see plugins
Solutions:
- Verify marketplace URL is accessible
- Check
.claude-plugin/marketplace.jsonexists at specified path - Validate JSON syntax:
claude plugin validate .or/plugin validate . - For private repos, confirm access permissions
Marketplace Validation Errors
Run claude plugin validate . or /plugin validate . from marketplace directory.
Common Errors
| Error | Cause | Solution |
|---|---|---|
File not found: .claude-plugin/marketplace.json | Missing manifest | Create .claude-plugin/marketplace.json with required fields |
Invalid JSON syntax: Unexpected token... | JSON syntax error | Check for missing/extra commas, unquoted strings |
Duplicate plugin name "x" found | Two plugins share same name | Give each plugin unique name value |
plugins[0].source: Path traversal not allowed | Source path contains .. | Use paths relative to marketplace root without .. |
Warnings (Non-blocking)
Marketplace has no plugins defined: Add at least one plugin topluginsarrayNo marketplace description provided: Addmetadata.descriptionPlugin "x" uses npm source...: Usegithubor local path sources instead
Plugin Installation Failures
Symptoms: Marketplace appears but installation fails
Solutions:
- Verify plugin source URLs are accessible
- Check plugin directories contain required files
- For GitHub sources, ensure repos are public or you have access
- Test plugin sources manually by cloning/downloading
Private Repository Authentication Fails
Manual Installation
- Verify authentication:
gh auth statusfor GitHub - Check credential helper:
git config --global credential.helper - Try cloning repository manually
Background Auto-Updates
- Verify token set:
echo $GITHUB_TOKEN - Check token permissions (read access to repository)
- GitHub: ensure
reposcope for private repos - GitLab: ensure at least
read_repositoryscope - Verify token not expired
Relative Paths Fail in URL-based Marketplaces
Symptoms: Added via URL (like https://example.com/marketplace.json), plugins with "./plugins/my-plugin" fail with "path not found"
Cause: URL-based marketplaces only download marketplace.json file, not plugin files.
Solutions:
- Use external sources (GitHub, npm, git URL) instead of relative paths:
{ "name": "my-plugin", "source": { "source": "github", "repo": "owner/repo" } }- Use Git-based marketplace (clones entire repo, relative paths work)
Files Not Found After Installation
Symptoms: Plugin installs but references to files fail, especially files outside plugin directory
Cause: Plugins copied to cache directory. Paths like ../shared-utils won't work.
Solutions:
- Use symlinks (followed during copying)
- Restructure so shared directory is inside plugin source path
- Reference: Plugin caching and file resolution docs
Script Quality Criteria
Scripts provide deterministic reliability and token efficiency.
When to Include Scripts
- Same code rewritten repeatedly
- Deterministic operations needed
- Complex transformations
- External tool integrations
Cross-Platform Requirements
Prefer: Node.js or Python Avoid: Bash scripts (not well-supported on Windows)
If bash required, provide Node.js/Python alternative.
Testing Requirements
Mandatory: All scripts must have tests
# Run tests before packaging
python -m pytest scripts/tests/
# or
npm testTests must pass. No skipping failed tests.
Environment Variables
Respect hierarchy (first found wins):
1. process.env (runtime) 2. $HOME/.claude/skills/<skill-name>/.env (skill-specific) 3. $HOME/.claude/skills/.env (shared skills) 4. $HOME/.claude/.env (global) 5. ./.claude/skills/${SKILL}/.env (cwd) 6. ./.claude/skills/.env (cwd) 7. ./.claude/.env (cwd)
Implementation pattern (Python):
from dotenv import load_dotenv
import os
# Load in reverse order (last loaded wins if not set)
load_dotenv('$HOME/.claude/.env')
load_dotenv('$HOME/.claude/skills/.env')
load_dotenv('$HOME/.claude/skills/my-skill/.env')
load_dotenv('./.claude/skills/my-skill/.env')
load_dotenv('./.claude/skills/.env')
load_dotenv('./.claude/.env')
# process.env already takes precedenceDocumentation Requirements
.env.example
Show required variables without values:
API_KEY=
DATABASE_URL=
DEBUG=falserequirements.txt (Python)
Pin major versions:
requests>=2.28.0
python-dotenv>=1.0.0package.json (Node.js)
Include scripts:
{
"scripts": {
"test": "jest"
}
}Manual Testing
Before packaging, test with real use cases:
# Example: PDF rotation script
python scripts/rotate_pdf.py input.pdf 90 output.pdfVerify output matches expectations.
Error Handling
- Clear error messages
- Graceful failures
- No silent errors
- Exit codes: 0 success, non-zero failure
Structure & Organization Criteria
Proper structure enables discovery and maintainability.
Required Directory Layout
.claude/skills/
└── skill-name/
├── SKILL.md # Required, uppercase
├── scripts/ # Optional: executable code
├── references/ # Optional: documentation
└── assets/ # Optional: output resourcesSKILL.md Requirements
File name: Exactly SKILL.md (uppercase)
YAML Frontmatter: Required at top
---
name: skill-name
description: Under 200 chars, specific triggers
license: Optional
version: Optional
---Resource Directories
scripts/
Executable code for deterministic tasks.
scripts/
├── main_operation.py
├── helper_utils.py
├── requirements.txt
├── .env.example
└── tests/
└── test_main_operation.pyreferences/
Documentation loaded into context as needed.
references/
├── api-documentation.md
├── schema-definitions.md
└── workflow-guides.mdassets/
Files used in output, not loaded into context.
assets/
├── templates/
├── images/
└── boilerplate/File Naming
Format: kebab-case, descriptive
Good:
api-endpoints-authentication.mddatabase-schema-users.mdrotate-pdf-script.py
Bad:
docs.md- not descriptiveapiEndpoints.md- wrong case1.md- meaningless
Cleanup
After initialization, delete unused example files:
# Remove if not needed
rm -rf scripts/example_script.py
rm -rf references/example_reference.md
rm -rf assets/example_asset.txtScope Consolidation
Related topics should be combined into single skill:
Consolidate:
cloudflare+cloudflare-r2+cloudflare-workers→devopsmongodb+postgresql→databases
Keep separate:
- Unrelated domains
- Different tech stacks with no overlap
Validation
Run packaging script to check structure:
scripts/package_skill.py <skill-path>Checks:
- SKILL.md exists
- Valid frontmatter
- Proper directory structure
Token Efficiency Criteria
Skills use progressive disclosure to minimize context window usage.
Three-Level Loading
1. Metadata - Always loaded (~200 chars) 2. SKILL.md body - Loaded when skill triggers (<150 lines) 3. Bundled resources - Loaded as needed (unlimited for scripts)
Size Limits
| Resource | Limit | Notes |
|---|---|---|
| Description | <200 chars | In YAML frontmatter |
| SKILL.md | <150 lines | Core instructions only |
| Each reference file | <150 lines | Split if larger |
| Scripts | No limit | Executed, not loaded into context |
SKILL.md Content Strategy
Include in SKILL.md:
- Purpose (2-3 sentences)
- When to use (trigger conditions)
- Quick reference for common workflows
- Pointers to resources (scripts, references, assets)
Move to references/:
- Detailed documentation
- Database schemas
- API specs
- Step-by-step guides
- Examples and templates
- Best practices
No Duplication Rule
Information lives in ONE place:
- Either in SKILL.md
- Or in references/
Bad: Schema overview in SKILL.md + detailed schema in references/schema.md Good: Brief mention in SKILL.md + full schema only in references/schema.md
Splitting Large Files
If reference exceeds 150 lines, split by logical boundaries:
references/
├── api-endpoints-auth.md # Auth endpoints
├── api-endpoints-users.md # User endpoints
├── api-endpoints-payments.md # Payment endpointsInclude grep patterns in SKILL.md for discoverability:
## API Documentation
- Auth: `references/api-endpoints-auth.md`
- Users: `references/api-endpoints-users.md`
- Payments: `references/api-endpoints-payments.md`Scripts: Best Token Efficiency
Scripts execute without loading into context.
When to use scripts:
- Repetitive code patterns
- Deterministic operations
- Complex transformations
Example: PDF rotation via scripts/rotate_pdf.py vs rewriting rotation code each time.
Skill Validation Checklist
Quick validation before packaging. Run scripts/package_skill.py for automated checks.
Critical (Must Pass)
Metadata
- [ ]
name: kebab-case, descriptive - [ ]
description: under 200 characters, specific triggers, not generic
Size Limits
- [ ] SKILL.md: under 150 lines
- [ ] Each reference file: under 150 lines
- [ ] No info duplication between SKILL.md and references
Structure
- [ ] SKILL.md exists with valid YAML frontmatter
- [ ] Unused example files deleted
- [ ] File names: kebab-case, self-documenting
Scripts (If Applicable)
- [ ] Tests exist and pass
- [ ] Cross-platform (Node.js/Python preferred)
- [ ] Env vars: respects hierarchy
process.env>$HOME/.claude/skills/${SKILL}/.env(global) >$HOME/.claude/skills/.env(global) >$HOME/.claude/.env(global) >./.claude/skills/${SKILL}/.env(cwd) >./.claude/skills/.env(cwd) >./.claude/.env(cwd) - [ ] Dependencies documented (requirements.txt, .env.example)
- [ ] Manually tested with real use cases
Quality
Writing Style
- [ ] Imperative form: "To accomplish X, do Y"
- [ ] Third-person metadata: "This skill should be used when..."
- [ ] Concise, no fluff
Practical Utility
- [ ] Teaches how to do tasks, not what tools are
- [ ] Based on real workflows
- [ ] Includes concrete trigger phrases/examples
Integration
- [ ] No duplication with existing skills
- [ ] Related topics consolidated (e.g., cloudflare + docker → devops)
- [ ] Composable with other skills
Automated Validation
Run packaging script to validate:
scripts/package_skill.py <path/to/skill-folder>Checks performed:
- YAML frontmatter format
- Required fields present
- Description length (<200 chars)
- Directory structure
- File organization
Fix all errors before distributing.
Subagent Delegation Enforcement
When a skill requires subagent delegation (via Task tool):
1. Use MUST language - "Use subagent" is weak; "MUST spawn subagent" is enforceable 2. Include Task pattern - Show exact syntax: Task(subagent_type="X", prompt="Y", description="Z") 3. Add validation rule - "If Task tool calls = 0 at end, workflow is INCOMPLETE" 4. Mark requirements clearly - Use table with "MUST spawn" column 5. Forbid direct implementation - "DO NOT implement X yourself - DELEGATE to subagent"
Anti-pattern (weak):
- Use `tester` agent for testingCorrect pattern (enforceable):
- **MUST** spawn `tester` subagent: `Task(subagent_type="tester", prompt="Run tests", description="Test")`
- DO NOT run tests yourself - DELEGATE#!/usr/bin/env python3
"""
Cross-platform encoding utilities for Windows compatibility.
Fixes UnicodeEncodeError on Windows by reconfiguring stdout/stderr to UTF-8
and providing encoding-aware file I/O helpers.
"""
import sys
from pathlib import Path
def configure_utf8_console():
"""
Reconfigure stdout/stderr for UTF-8 on Windows.
Windows uses cp1252 by default which cannot encode Unicode emojis.
This function switches to UTF-8 with 'replace' error handling to
prevent crashes on truly incompatible terminals.
"""
if sys.platform == 'win32':
try:
sys.stdout.reconfigure(encoding='utf-8', errors='replace')
sys.stderr.reconfigure(encoding='utf-8', errors='replace')
except AttributeError:
pass # Python < 3.7
def read_text_utf8(path: Path) -> str:
"""Read file with explicit UTF-8 encoding."""
return path.read_text(encoding='utf-8')
def write_text_utf8(path: Path, content: str) -> None:
"""Write file with explicit UTF-8 encoding."""
path.write_text(content, encoding='utf-8')
#!/usr/bin/env python3
"""
Skill Initializer - Creates a new skill from template
Usage:
init_skill.py <skill-name> --path <path>
Examples:
init_skill.py my-new-skill --path skills/public
init_skill.py my-api-helper --path skills/private
init_skill.py custom-skill --path /custom/location
"""
import sys
from pathlib import Path
from encoding_utils import configure_utf8_console, write_text_utf8
# Fix Windows console encoding for Unicode output (emojis, arrows)
configure_utf8_console()
SKILL_TEMPLATE = """---
name: {skill_name}
description: [TODO: Complete and informative explanation of what the skill does and when to use it. Include WHEN to use this skill - specific scenarios, file types, or tasks that trigger it.]
---
# {skill_title}
## Overview
[TODO: 1-2 sentences explaining what this skill enables]
## Structuring This Skill
[TODO: Choose the structure that best fits this skill's purpose. Common patterns:
**1. Workflow-Based** (best for sequential processes)
- Works well when there are clear step-by-step procedures
- Example: DOCX skill with "Workflow Decision Tree" → "Reading" → "Creating" → "Editing"
- Structure: ## Overview → ## Workflow Decision Tree → ## Step 1 → ## Step 2...
**2. Task-Based** (best for tool collections)
- Works well when the skill offers different operations/capabilities
- Example: PDF skill with "Quick Start" → "Merge PDFs" → "Split PDFs" → "Extract Text"
- Structure: ## Overview → ## Quick Start → ## Task Category 1 → ## Task Category 2...
**3. Reference/Guidelines** (best for standards or specifications)
- Works well for brand guidelines, coding standards, or requirements
- Example: Brand styling with "Brand Guidelines" → "Colors" → "Typography" → "Features"
- Structure: ## Overview → ## Guidelines → ## Specifications → ## Usage...
**4. Capabilities-Based** (best for integrated systems)
- Works well when the skill provides multiple interrelated features
- Example: Product Management with "Core Capabilities" → numbered capability list
- Structure: ## Overview → ## Core Capabilities → ### 1. Feature → ### 2. Feature...
Patterns can be mixed and matched as needed. Most skills combine patterns (e.g., start with task-based, add workflow for complex operations).
Delete this entire "Structuring This Skill" section when done - it's just guidance.]
## [TODO: Replace with the first main section based on chosen structure]
[TODO: Add content here. See examples in existing skills:
- Code samples for technical skills
- Decision trees for complex workflows
- Concrete examples with realistic user requests
- References to scripts/templates/references as needed]
## Resources
This skill includes example resource directories that demonstrate how to organize different types of bundled resources:
### scripts/
Executable code (Python/Bash/etc.) that can be run directly to perform specific operations.
**Examples from other skills:**
- PDF skill: `fill_fillable_fields.py`, `extract_form_field_info.py` - utilities for PDF manipulation
- DOCX skill: `document.py`, `utilities.py` - Python modules for document processing
**Appropriate for:** Python scripts, shell scripts, or any executable code that performs automation, data processing, or specific operations.
**Note:** Scripts may be executed without loading into context, but can still be read by Claude for patching or environment adjustments.
### references/
Documentation and reference material intended to be loaded into context to inform Claude's process and thinking.
**Examples from other skills:**
- Product management: `communication.md`, `context_building.md` - detailed workflow guides
- BigQuery: API reference documentation and query examples
- Finance: Schema documentation, company policies
**Appropriate for:** In-depth documentation, API references, database schemas, comprehensive guides, or any detailed information that Claude should reference while working.
### assets/
Files not intended to be loaded into context, but rather used within the output Claude produces.
**Examples from other skills:**
- Brand styling: PowerPoint template files (.pptx), logo files
- Frontend builder: HTML/React boilerplate project directories
- Typography: Font files (.ttf, .woff2)
**Appropriate for:** Templates, boilerplate code, document templates, images, icons, fonts, or any files meant to be copied or used in the final output.
---
**Any unneeded directories can be deleted.** Not every skill requires all three types of resources.
"""
EXAMPLE_SCRIPT = '''#!/usr/bin/env python3
"""
Example helper script for {skill_name}
This is a placeholder script that can be executed directly.
Replace with actual implementation or delete if not needed.
Example real scripts from other skills:
- pdf/scripts/fill_fillable_fields.py - Fills PDF form fields
- pdf/scripts/convert_pdf_to_images.py - Converts PDF pages to images
"""
def main():
print("This is an example script for {skill_name}")
# TODO: Add actual script logic here
# This could be data processing, file conversion, API calls, etc.
if __name__ == "__main__":
main()
'''
EXAMPLE_REFERENCE = """# Reference Documentation for {skill_title}
This is a placeholder for detailed reference documentation.
Replace with actual reference content or delete if not needed.
Example real reference docs from other skills:
- product-management/references/communication.md - Comprehensive guide for status updates
- product-management/references/context_building.md - Deep-dive on gathering context
- bigquery/references/ - API references and query examples
## When Reference Docs Are Useful
Reference docs are ideal for:
- Comprehensive API documentation
- Detailed workflow guides
- Complex multi-step processes
- Information too lengthy for main SKILL.md
- Content that's only needed for specific use cases
## Structure Suggestions
### API Reference Example
- Overview
- Authentication
- Endpoints with examples
- Error codes
- Rate limits
### Workflow Guide Example
- Prerequisites
- Step-by-step instructions
- Common patterns
- Troubleshooting
- Best practices
"""
EXAMPLE_ASSET = """# Example Asset File
This placeholder represents where asset files would be stored.
Replace with actual asset files (templates, images, fonts, etc.) or delete if not needed.
Asset files are NOT intended to be loaded into context, but rather used within
the output Claude produces.
Example asset files from other skills:
- Brand guidelines: logo.png, slides_template.pptx
- Frontend builder: hello-world/ directory with HTML/React boilerplate
- Typography: custom-font.ttf, font-family.woff2
- Data: sample_data.csv, test_dataset.json
## Common Asset Types
- Templates: .pptx, .docx, boilerplate directories
- Images: .png, .jpg, .svg, .gif
- Fonts: .ttf, .otf, .woff, .woff2
- Boilerplate code: Project directories, starter files
- Icons: .ico, .svg
- Data files: .csv, .json, .xml, .yaml
Note: This is a text placeholder. Actual assets can be any file type.
"""
def title_case_skill_name(skill_name):
"""Convert hyphenated skill name to Title Case for display."""
return ' '.join(word.capitalize() for word in skill_name.split('-'))
def init_skill(skill_name, path):
"""
Initialize a new skill directory with template SKILL.md.
Args:
skill_name: Name of the skill
path: Path where the skill directory should be created
Returns:
Path to created skill directory, or None if error
"""
# Determine skill directory path
skill_dir = Path(path).resolve() / skill_name
# Check if directory already exists
if skill_dir.exists():
print(f"❌ Error: Skill directory already exists: {skill_dir}")
return None
# Create skill directory
try:
skill_dir.mkdir(parents=True, exist_ok=False)
print(f"✅ Created skill directory: {skill_dir}")
except Exception as e:
print(f"❌ Error creating directory: {e}")
return None
# Create SKILL.md from template
skill_title = title_case_skill_name(skill_name)
skill_content = SKILL_TEMPLATE.format(
skill_name=skill_name,
skill_title=skill_title
)
skill_md_path = skill_dir / 'SKILL.md'
try:
write_text_utf8(skill_md_path, skill_content)
print("✅ Created SKILL.md")
except Exception as e:
print(f"❌ Error creating SKILL.md: {e}")
return None
# Create resource directories with example files
try:
# Create scripts/ directory with example script
scripts_dir = skill_dir / 'scripts'
scripts_dir.mkdir(exist_ok=True)
example_script = scripts_dir / 'example.py'
write_text_utf8(example_script, EXAMPLE_SCRIPT.format(skill_name=skill_name))
example_script.chmod(0o755)
print("✅ Created scripts/example.py")
# Create references/ directory with example reference doc
references_dir = skill_dir / 'references'
references_dir.mkdir(exist_ok=True)
example_reference = references_dir / 'api_reference.md'
write_text_utf8(example_reference, EXAMPLE_REFERENCE.format(skill_title=skill_title))
print("✅ Created references/api_reference.md")
# Create assets/ directory with example asset placeholder
assets_dir = skill_dir / 'assets'
assets_dir.mkdir(exist_ok=True)
example_asset = assets_dir / 'example_asset.txt'
write_text_utf8(example_asset, EXAMPLE_ASSET)
print("✅ Created assets/example_asset.txt")
except Exception as e:
print(f"❌ Error creating resource directories: {e}")
return None
# Print next steps
print(f"\n✅ Skill '{skill_name}' initialized successfully at {skill_dir}")
print("\nNext steps:")
print("1. Edit SKILL.md to complete the TODO items and update the description")
print("2. Customize or delete the example files in scripts/, references/, and assets/")
print("3. Run the validator when ready to check the skill structure")
return skill_dir
def main():
if len(sys.argv) < 4 or sys.argv[2] != '--path':
print("Usage: init_skill.py <skill-name> --path <path>")
print("\nSkill name requirements:")
print(" - Hyphen-case identifier (e.g., 'data-analyzer')")
print(" - Lowercase letters, digits, and hyphens only")
print(" - Max 40 characters")
print(" - Must match directory name exactly")
print("\nExamples:")
print(" init_skill.py my-new-skill --path skills/public")
print(" init_skill.py my-api-helper --path skills/private")
print(" init_skill.py custom-skill --path /custom/location")
sys.exit(1)
skill_name = sys.argv[1]
path = sys.argv[3]
print(f"🚀 Initializing skill: {skill_name}")
print(f" Location: {path}")
print()
result = init_skill(skill_name, path)
if result:
sys.exit(0)
else:
sys.exit(1)
if __name__ == "__main__":
main()
#!/usr/bin/env python3
"""
Skill Packager - Creates a distributable zip file of a skill folder
Usage:
python utils/package_skill.py <path/to/skill-folder> [output-directory]
Example:
python utils/package_skill.py skills/public/my-skill
python utils/package_skill.py skills/public/my-skill ./dist
"""
import sys
import zipfile
from pathlib import Path
from encoding_utils import configure_utf8_console
from quick_validate import validate_skill
# Fix Windows console encoding for Unicode output (emojis, arrows)
configure_utf8_console()
def package_skill(skill_path, output_dir=None):
"""
Package a skill folder into a zip file.
Args:
skill_path: Path to the skill folder
output_dir: Optional output directory for the zip file (defaults to current directory)
Returns:
Path to the created zip file, or None if error
"""
skill_path = Path(skill_path).resolve()
# Validate skill folder exists
if not skill_path.exists():
print(f"❌ Error: Skill folder not found: {skill_path}")
return None
if not skill_path.is_dir():
print(f"❌ Error: Path is not a directory: {skill_path}")
return None
# Validate SKILL.md exists
skill_md = skill_path / "SKILL.md"
if not skill_md.exists():
print(f"❌ Error: SKILL.md not found in {skill_path}")
return None
# Run validation before packaging
print("🔍 Validating skill...")
valid, message = validate_skill(skill_path)
if not valid:
print(f"❌ Validation failed: {message}")
print(" Please fix the validation errors before packaging.")
return None
print(f"✅ {message}\n")
# Determine output location
skill_name = skill_path.name
if output_dir:
output_path = Path(output_dir).resolve()
output_path.mkdir(parents=True, exist_ok=True)
else:
output_path = Path.cwd()
zip_filename = output_path / f"{skill_name}.zip"
# Create the zip file
try:
with zipfile.ZipFile(zip_filename, 'w', zipfile.ZIP_DEFLATED) as zipf:
# Walk through the skill directory
for file_path in skill_path.rglob('*'):
if file_path.is_file():
# Calculate the relative path within the zip
arcname = file_path.relative_to(skill_path.parent)
zipf.write(file_path, arcname)
print(f" Added: {arcname}")
print(f"\n✅ Successfully packaged skill to: {zip_filename}")
return zip_filename
except Exception as e:
print(f"❌ Error creating zip file: {e}")
return None
def main():
if len(sys.argv) < 2:
print("Usage: python utils/package_skill.py <path/to/skill-folder> [output-directory]")
print("\nExample:")
print(" python utils/package_skill.py skills/public/my-skill")
print(" python utils/package_skill.py skills/public/my-skill ./dist")
sys.exit(1)
skill_path = sys.argv[1]
output_dir = sys.argv[2] if len(sys.argv) > 2 else None
print(f"📦 Packaging skill: {skill_path}")
if output_dir:
print(f" Output directory: {output_dir}")
print()
result = package_skill(skill_path, output_dir)
if result:
sys.exit(0)
else:
sys.exit(1)
if __name__ == "__main__":
main()
#!/usr/bin/env python3
"""
Quick validation script for skills - minimal version
"""
import sys
import re
from pathlib import Path
from encoding_utils import configure_utf8_console, read_text_utf8
# Fix Windows console encoding for Unicode output
configure_utf8_console()
def validate_skill(skill_path):
"""Basic validation of a skill"""
skill_path = Path(skill_path)
# Check SKILL.md exists
skill_md = skill_path / 'SKILL.md'
if not skill_md.exists():
return False, "SKILL.md not found"
# Read and validate frontmatter
content = read_text_utf8(skill_md)
if not content.startswith('---'):
return False, "No YAML frontmatter found"
# Extract frontmatter
match = re.match(r'^---\n(.*?)\n---', content, re.DOTALL)
if not match:
return False, "Invalid frontmatter format"
frontmatter = match.group(1)
# Check required fields
if 'name:' not in frontmatter:
return False, "Missing 'name' in frontmatter"
if 'description:' not in frontmatter:
return False, "Missing 'description' in frontmatter"
# Extract name for validation
name_match = re.search(r'name:\s*(.+)', frontmatter)
if name_match:
name = name_match.group(1).strip()
# Check naming convention (hyphen-case: lowercase with hyphens)
if not re.match(r'^[a-z0-9-]+$', name):
return False, f"Name '{name}' should be hyphen-case (lowercase letters, digits, and hyphens only)"
if name.startswith('-') or name.endswith('-') or '--' in name:
return False, f"Name '{name}' cannot start/end with hyphen or contain consecutive hyphens"
# Extract and validate description
desc_match = re.search(r'description:\s*(.+)', frontmatter)
if desc_match:
description = desc_match.group(1).strip()
# Check for angle brackets
if '<' in description or '>' in description:
return False, "Description cannot contain angle brackets (< or >)"
return True, "Skill is valid!"
if __name__ == "__main__":
if len(sys.argv) != 2:
print("Usage: python quick_validate.py <skill_directory>")
sys.exit(1)
valid, message = validate_skill(sys.argv[1])
print(message)
sys.exit(0 if valid else 1)Related skills
How it compares
Choose skill-creator when you need full SKILL.md scaffolding, validation scripts, and zip packaging rather than a lightweight single-file prompt.
FAQ
What files does skill-creator require in a skill folder?
skill-creator requires a SKILL.md with YAML frontmatter (name and description under 200 characters) plus optional scripts/, references/, and assets/ directories. The main SKILL.md body should stay under 150 lines, splitting detail into reference files loaded on demand.
How does skill-creator validate skills before distribution?
skill-creator runs package_skill.py, which checks YAML frontmatter, naming conventions, directory structure, description quality, and resource references. Validation must pass before the script emits a distributable zip named after the skill.
When should developers use skill-creator over writing prompts?
skill-creator fits when a workflow repeats across projects and needs auto-triggered metadata, bundled scripts, reference docs, or marketplace packaging. One-off questions without reusable triggers do not need a packaged skill.