skill-name
Brief description of what this skill does (1-2 sentences). Include when to use it: "Use when..." or "Use for..."
SKILL.md
| Name | skill-name |
| Description | Brief description of what this skill does (1-2 sentences). Include when to use it: "Use when..." or "Use for..." |
name: skill-name description: | Brief description of what this skill does (1-2 sentences). Include when to use it: "Use when..." or "Use for..." license: Apache-2.0 compatibility: |
- Python 3.9+
- Required packages: list-them-here metadata: author: your-name version: "1.0.0" category: baseline # or cybersecurity
Skill Name
Brief overview of the skill's purpose and capabilities.
Capabilities
- Capability 1: Description of first main capability
- Capability 2: Description of second main capability
- Capability 3: Description of third main capability
Quick Start
Minimal example to get started:
# Quick example code
Usage
Task 1: [Task Name]
Description of what this task accomplishes.
Input: Description of expected input
Process:
- Step one
- Step two
- Step three
Output: Description of what gets produced
Example:
# Example code for task 1
Task 2: [Task Name]
Description of what this task accomplishes.
Input: Description of expected input
Process:
- Step one
- Step two
Output: Description of what gets produced
Example:
# Example code for task 2
Configuration
Environment Variables
| Variable | Description | Required | Default |
|---|---|---|---|
VAR_NAME | Description | No | default |
Options
| Option | Type | Description |
|---|---|---|
option_name | string | Description |
Examples
Example 1: [Scenario Name]
Scenario: Description of the use case
Input:
Input example
Output:
Output example
Example 2: [Scenario Name]
Scenario: Description of the use case
Input:
Input example
Output:
Output example
Limitations
- Limitation 1: Description and workaround if any
- Limitation 2: Description and workaround if any
Troubleshooting
Common Issue 1
Problem: Description of the issue
Solution: How to resolve it
Common Issue 2
Problem: Description of the issue
Solution: How to resolve it
Related Skills
- skill-name: Brief description of relationship
- other-skill: Brief description of relationship
References
- Reference Guide: Detailed technical documentation
- External Resource: Description