# Example Skill

> An example skill demonstrating the Agent Skills format. Use this as a template for creating your own skills.

- Skill: `uwe-schwarz/example-skill` (Agent Skill, multi-file: 3 files)
- Install (CLI): `npx skillmds@latest add uwe-schwarz/example-skill`
- Raw SKILL.md: https://api.skillmd.com/api/skills/uwe-schwarz/example-skill/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: AI & ML
- License: MIT
- Author: uwe-schwarz (https://skillmd.com/u/uwe-schwarz)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/uwe-schwarz/example-skill

---


# Example Skill

This is an example skill that demonstrates how to structure skills for AI coding agents.

## When to Apply

Reference these guidelines when:
- Creating new skills
- Understanding the skill format
- Learning best practices for skill development

## Core Guidelines

### 1. Frontmatter Requirements

Every `SKILL.md` file must include:
- `name`: Unique identifier (lowercase, hyphens for spaces)
- `description`: Clear description of what the skill does and when to use it

Optional fields:
- `license`: License type (e.g., MIT)
- `metadata`: Additional information (author, version, etc.)

### 2. Content Structure

Organize your skill content with:
- Clear headings
- Code examples
- Use cases
- Best practices

### 3. Script Integration

If your skill includes scripts:
- Place them in the `scripts/` directory
- Make scripts executable
- Document usage in this file

### 4. References

Include supporting documentation in:
- The `references/` directory
- Links to external resources
- Relevant documentation

## Example Usage

```bash
# Using the skill in a conversation
"Use the example-skill to help me create a new skill"
```

## Best Practices

- Keep descriptions clear and concise
- Use specific examples
- Document edge cases
- Include troubleshooting steps

## Sub-rules

If your skill is complex, you can break it down into sub-rules in the `rules/` directory:
- Create separate markdown files for each rule
- Reference them from this main SKILL.md
- Use descriptive filenames (e.g., `rule-name.md`)