|
| 1 | +# Agent Skills |
| 2 | + |
| 3 | +This directory contains agentic skills for the Morphir Python project, following the [Agent Skills Specification](https://agentskills.io/). |
| 4 | + |
| 5 | +## What are Agent Skills? |
| 6 | + |
| 7 | +Agent Skills are folders of instructions, scripts, and resources that AI agents can discover and use to perform tasks more accurately and efficiently. They provide a simple, open format for extending agent capabilities with: |
| 8 | + |
| 9 | +- **Procedural knowledge** - Step-by-step instructions for complex tasks |
| 10 | +- **Contextual information** - Project-specific knowledge |
| 11 | +- **Scripts** - Executable code for common operations |
| 12 | +- **References** - Additional documentation |
| 13 | + |
| 14 | +## Directory Structure |
| 15 | + |
| 16 | +Each skill should be in its own subdirectory with a `SKILL.md` file: |
| 17 | + |
| 18 | +``` |
| 19 | +.agents/skills/ |
| 20 | +├── README.md # This file |
| 21 | +├── skill-name/ |
| 22 | +│ ├── SKILL.md # Required - skill definition |
| 23 | +│ ├── scripts/ # Optional - executable scripts |
| 24 | +│ ├── references/ # Optional - additional docs |
| 25 | +│ └── assets/ # Optional - templates, data files |
| 26 | +└── another-skill/ |
| 27 | + └── SKILL.md |
| 28 | +``` |
| 29 | + |
| 30 | +## SKILL.md Format |
| 31 | + |
| 32 | +Each skill must have a `SKILL.md` file with YAML frontmatter: |
| 33 | + |
| 34 | +```yaml |
| 35 | +--- |
| 36 | +name: skill-name |
| 37 | +description: A description of what this skill does and when to use it. |
| 38 | +license: Apache-2.0 |
| 39 | +compatibility: Requirements (e.g., "Requires Python 3.14+") |
| 40 | +metadata: |
| 41 | + author: finos |
| 42 | + version: "1.0" |
| 43 | +--- |
| 44 | + |
| 45 | +# Skill Instructions |
| 46 | + |
| 47 | +Step-by-step instructions for the skill... |
| 48 | +``` |
| 49 | + |
| 50 | +### Required Fields |
| 51 | + |
| 52 | +| Field | Description | |
| 53 | +|-------|-------------| |
| 54 | +| `name` | Lowercase, hyphenated name (must match directory name) | |
| 55 | +| `description` | What the skill does and when to use it (max 1024 chars) | |
| 56 | + |
| 57 | +### Optional Fields |
| 58 | + |
| 59 | +| Field | Description | |
| 60 | +|-------|-------------| |
| 61 | +| `license` | License for the skill | |
| 62 | +| `compatibility` | Environment requirements | |
| 63 | +| `metadata` | Additional key-value metadata | |
| 64 | +| `allowed-tools` | Pre-approved tools for the skill | |
| 65 | + |
| 66 | +## Creating a New Skill |
| 67 | + |
| 68 | +1. Create a directory with your skill name (lowercase, hyphenated) |
| 69 | +2. Add a `SKILL.md` file with the required frontmatter |
| 70 | +3. Add any supporting scripts, references, or assets |
| 71 | +4. Test the skill with an agent to verify it works correctly |
| 72 | + |
| 73 | +## Validation |
| 74 | + |
| 75 | +Use the reference library to validate skills: |
| 76 | + |
| 77 | +```bash |
| 78 | +npx skills-ref validate ./skill-name |
| 79 | +``` |
| 80 | + |
| 81 | +## Resources |
| 82 | + |
| 83 | +- [Agent Skills Specification](https://agentskills.io/specification) |
| 84 | +- [Example Skills](https://github.com/anthropics/skills) |
| 85 | +- [Reference Library](https://github.com/agentskills/agentskills/tree/main/skills-ref) |
0 commit comments