agent/agentskills
2
0
Fork 0
mirror of https://github.com/agentskills/agentskills.git synced 2026-06-18 15:54:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move frontmatter field table above examples in specification doc

Browse Source 
Place the field constraints table immediately after the `Frontmatter`
heading so readers see the reference before the examples. Also remove
"(required)" from the heading, wrap examples in a `<Card>`, and relabel
"With optional fields:" to "Example with optional fields:".

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Jonathan Hefner
2026-03-06 16:30:44 -06:00
Unverified
parent 7a05447ecb
commit 5d16d72435
1 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/specification.mdx
+15 -11
View File
@@ -21,7 +21,19 @@ skill-name/
The `SKILL.md` file must contain YAML frontmatter followed by Markdown content.
### Frontmatter (required)
### Frontmatter
| Field | Required | Constraints |
|-------|----------|-------------|
| `name` | Yes | Max 64 characters. Lowercase letters, numbers, and hyphens only. Must not start or end with a hyphen. |
| `description` | Yes | Max 1024 characters. Non-empty. Describes what the skill does and when to use it. |
| `license` | No | License name or reference to a bundled license file. |
| `compatibility` | No | Max 500 characters. Indicates environment requirements (intended product, system packages, network access, etc.). |
| `metadata` | No | Arbitrary key-value mapping for additional metadata. |
| `allowed-tools` | No | Space-delimited list of pre-approved tools the skill may use. (Experimental) |
<Card>
**Minimal example:**
```markdown SKILL.md
---
@@ -30,7 +42,7 @@ description: A description of what this skill does and when to use it.
---
```
**With optional fields:**
**Example with optional fields:**
```markdown SKILL.md
---
@@ -42,15 +54,7 @@ metadata:
version: "1.0"
---
```
| Field | Required | Constraints |
|-------|----------|-------------|
| `name` | Yes | Max 64 characters. Lowercase letters, numbers, and hyphens only. Must not start or end with a hyphen. |
| `description` | Yes | Max 1024 characters. Non-empty. Describes what the skill does and when to use it. |
| `license` | No | License name or reference to a bundled license file. |
| `compatibility` | No | Max 500 characters. Indicates environment requirements (intended product, system packages, network access, etc.). |
| `metadata` | No | Arbitrary key-value mapping for additional metadata. |
| `allowed-tools` | No | Space-delimited list of pre-approved tools the skill may use. (Experimental) |
</Card>
#### `name` field