From openhands-skills
Guides creation of effective skills for OpenHands including anatomy, YAML metadata, progressive disclosure, bundled resources, scripts, and references.
npx claudepluginhub openhands/extensionsThis skill uses the workspace's default tool permissions.
This skill provides guidance for creating effective skills.
Guides creation of effective skills for Codex with principles on conciseness, degrees of freedom, and anatomy. Use when building or updating skills with specialized knowledge, workflows, or tools.
Guides creation of effective skills extending AI model capabilities with specialized knowledge, workflows, and tool integrations. Useful when users request new or updated skills.
Guides Next.js Cache Components and Partial Prerendering (PPR) with cacheComponents enabled. Implements 'use cache', cacheLife(), cacheTag(), revalidateTag(), static/dynamic optimization, and cache debugging.
Share bugs, ideas, or general feedback.
This skill provides guidance for creating effective skills.
Skills are modular, self-contained packages that extend OpenHands's capabilities by providing specialized knowledge, workflows, and tools. Think of them as "onboarding guides" for specific domains or tasks—they transform OpenHands from a general-purpose agent into a specialized agent equipped with procedural knowledge that no model can fully possess.
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)
│ └── 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.)
Metadata Quality: The name and description in YAML frontmatter determine when OpenHands will use the skill. Be specific about what the skill does and when to use it. Use the third-person (e.g. "This skill should be used when..." instead of "Use this skill when...").
scripts/)Executable code (Python/Bash/etc.) for tasks that require deterministic reliability or are repeatedly rewritten.
scripts/rotate_pdf.py for PDF rotation tasksreferences/)Documentation and reference material intended to be loaded as needed into context to inform OpenHands's process and thinking.
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 specificationsassets/)Files not intended to be loaded into context, but rather used within the output OpenHands produces.
assets/logo.png for brand assets, assets/slides.pptx for PowerPoint templates, assets/frontend-template/ for HTML/React boilerplate, assets/font.ttf for typographySkills use a three-level loading system to manage context efficiently:
*Unlimited because scripts can be executed without reading into context window.
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.
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:
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.
To turn concrete examples into an effective skill, analyze each example by:
Example: When building a pdf-editor skill to handle queries like "Help me rotate this PDF," the analysis shows:
scripts/rotate_pdf.py script would be helpful to store in the skillExample: 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:
assets/hello-world/ template containing the boilerplate HTML/React project files would be helpful to store in the skillExample: When building a big-query skill to handle queries like "How many users have logged in today?" the analysis shows:
references/schema.md file documenting the table schemas would be helpful to store in the skillTo establish the skill's contents, analyze each concrete example to create a list of the reusable resources to include: scripts, references, and assets.
Create the skill directory structure:
mkdir -p skill-name/{references,scripts,assets}
touch skill-name/SKILL.md
Alternatively, use the init_skill.py script to generate a template:
scripts/init_skill.py <skill-name> --path <output-directory>
The script creates a skill directory with SKILL.md template and example resource directories.
When editing the (newly-created or existing) skill, remember that the skill is being created for another instance of OpenHands to use. Focus on including information that would be beneficial and non-obvious to OpenHands. Consider what procedural knowledge, domain-specific details, or reusable assets would help another OpenHands instance execute these tasks more effectively.
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. Create only the directories you actually need (references/, scripts/, assets/).
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.
Description (Frontmatter): Use third-person format with specific trigger phrases:
---
name: skill-name
description: This skill should be used when the user asks to "specific phrase 1", "specific phrase 2", "specific phrase 3". Include exact phrases users would say that should trigger this skill. Be concrete and specific.
---
Good description examples:
description: This skill should be used when the user asks to "create a hook", "add a PreToolUse hook", "validate tool use", "implement prompt-based hooks", or mentions hook events (PreToolUse, PostToolUse, Stop).
Bad description examples:
description: Use this skill when working with hooks. # Wrong person, vague
description: Load when user needs hook help. # Not third person
description: Provides hook guidance. # No trigger phrases
To complete SKILL.md body, answer the following questions:
Keep SKILL.md lean: Target 1,500-2,000 words for the body. Move detailed content to references/:
references/patterns.mdreferences/advanced.mdreferences/migration.mdreferences/api-reference.mdReference resources in SKILL.md:
## Additional Resources
### Reference Files
For detailed patterns and techniques, consult:
- **`references/patterns.md`** - Common patterns
- **`references/advanced.md`** - Advanced use cases
### Example Files
Working examples in `examples/`:
- **`example-script.sh`** - Working example
Use the validation script to check basic requirements:
scripts/quick_validate.py <path/to/skill-folder>
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:
Common improvements:
Include (always loaded when skill triggers):
Keep under 3,000 words, ideally 1,500-2,000 words
Move to references/ (loaded as needed):
Each reference file can be large (2,000-5,000+ words)
Utility scripts:
Should be executable and documented
Write using verb-first instructions, not second person:
Correct (imperative):
To create a hook, define the event type.
Configure the MCP server with authentication.
Validate settings before use.
Incorrect (second person):
You should create a hook by defining the event type.
You need to configure the MCP server.
You must validate settings before use.
The frontmatter description must use third person:
Correct:
description: This skill should be used when the user asks to "create X", "configure Y"...
Incorrect:
description: Use this skill when you want to create X...
description: Load this skill when user asks...
Focus on what to do, not who should do it:
Correct:
Parse the frontmatter using sed.
Extract fields with grep.
Validate values before use.
Incorrect:
You can parse the frontmatter...
OpenHands should extract fields...
The user might validate values...
Before finalizing a skill:
Structure:
name and description fieldsDescription Quality:
Content Quality:
Progressive Disclosure:
Testing:
❌ Bad:
description: Provides guidance for working with hooks.
Why bad: Vague, no specific trigger phrases, not third person
✅ Good:
description: This skill should be used when the user asks to "create a hook", "add a PreToolUse hook", "validate tool use", or mentions hook events. Provides comprehensive hooks API guidance.
Why good: Third person, specific phrases, concrete scenarios
❌ Bad:
skill-name/
└── SKILL.md (8,000 words - everything in one file)
Why bad: Bloats context when skill loads, detailed content always loaded
✅ Good:
skill-name/
├── SKILL.md (1,800 words - core essentials)
└── references/
├── patterns.md (2,500 words)
└── advanced.md (3,700 words)
Why good: Progressive disclosure, detailed content loaded only when needed
❌ Bad:
You should start by reading the configuration file.
You need to validate the input.
You can use the grep tool to search.
Why bad: Second person, not imperative form
✅ Good:
Start by reading the configuration file.
Validate the input before processing.
Use the grep tool to search for patterns.
Why good: Imperative form, direct instructions
❌ Bad:
# SKILL.md
[Core content]
[No mention of references/ or examples/]
Why bad: OpenHands doesn't know references exist
✅ Good:
# SKILL.md
[Core content]
## Additional Resources
### Reference Files
- **`references/patterns.md`** - Detailed patterns
- **`references/advanced.md`** - Advanced techniques
### Scripts
- **`scripts/validate.sh`** - Validation utility
Why good: OpenHands knows where to find additional information
skill-name/
└── SKILL.md
Good for: Simple knowledge, no complex resources needed
skill-name/
├── SKILL.md
├── references/
│ └── detailed-guide.md
└── scripts/
└── helper.py
Good for: Most skills with detailed documentation
skill-name/
├── SKILL.md
├── references/
│ ├── patterns.md
│ └── advanced.md
├── scripts/
│ └── validate.sh
└── assets/
└── template.txt
Good for: Complex domains with validation utilities
✅ DO:
❌ DON'T:
For detailed patterns and techniques, consult:
references/workflows.md - Sequential workflows and conditional logic patternsreferences/output-patterns.md - Template and example patterns for specific output formatsTo create a skill:
mkdir -p skill-name/{references,scripts,assets}Focus on strong trigger descriptions, progressive disclosure, and imperative writing style for effective skills that load when needed and provide targeted guidance.