SKILL.md File Format
The SKILL.md file is the heart of every AI agent skill. It defines what your skill does and how AI agents should use it.
Basic Structure
# Skill Name
## Description
A brief description of what this skill does.
## Capabilities
- Capability 1
- Capability 2
- Capability 3
## Usage
Instructions on how to use this skill.
## Examples
```
Example usage of the skill
```
Required Sections
-
Title (H1)
The name of your skill, displayed in the directory.
-
Description
A clear explanation of what the skill does.
-
Capabilities
A list of what the skill can do.
Optional Sections
-
Usage
Detailed instructions on how to use the skill.
-
Examples
Practical examples showing the skill in action.
-
Requirements
Any dependencies or prerequisites.
-
Configuration
Configuration options if applicable.
Example SKILL.md
# Code Review Assistant
## Description
An AI skill that helps review code for best practices, potential bugs, and improvements.
## Capabilities
- Analyze code for common anti-patterns
- Suggest performance improvements
- Check for security vulnerabilities
- Recommend code style improvements
## Usage
Simply paste your code and ask for a review. You can specify the programming language and focus areas.
## Examples
```
Review this Python function for potential improvements:
def calculate_sum(numbers):
total = 0
for n in numbers:
total = total + n
return total
```
## Requirements
- Works best with code snippets under 500 lines
- Supports most popular programming languages
Best Practices
- Keep descriptions clear and concise
- List all capabilities accurately
- Provide practical examples
- Include any limitations or requirements
- Use proper Markdown formatting