ディレクトリ構造
スキルは、最低限SKILL.md を含むディレクトリです。
SKILL.md 形式
SKILL.md は YAML frontmatter と Markdown 本文で構成します。
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) |
最小例:任意項目を含む例:
SKILL.md
SKILL.md
name field
必須項目 name:
- 1-64 文字
- 小文字の英数字とハイフン(
a-zと-)のみ - 先頭・末尾に
-は不可 --は不可- 親ディレクトリ名と一致
有効な例:無効な例:
description field
必須項目 description:
- 1-1024 文字
- スキルの機能と利用タイミングを説明する
- エージェントが関連タスクを判定しやすい具体的キーワードを含める
良い例:悪い例:
license field
任意項目 license:
- スキルに適用されるライセンスを指定
- 短い表現を推奨
例:
compatibility field
任意項目 compatibility:
- 指定する場合は 1-500 文字
- 特定環境要件がある場合のみ記載を推奨
- 対応製品、必要パッケージ、ネットワーク要件などを示せる
例:
多くのスキルでは
compatibility は不要です。metadata field
任意項目 metadata:
- 文字列キーと文字列値のマップ
- 仕様で定義されていない追加情報を保持できる
例:
allowed-tools field
任意項目 allowed-tools:
- 事前承認されたツールのスペース区切りリスト
- Experimental。実装ごとに対応状況が異なる
例:
本文
frontmatter 以降の Markdown 本文にスキル指示を記述します。形式の制約はありません。 推奨セクション:- 手順
- 入出力例
- 典型的なエッジケース
Optional directories
scripts/
エージェントが実行できるコードを配置します。スクリプトは以下を満たすべきです。
- 自己完結、または依存関係を明記
- 分かりやすいエラーメッセージ
- エッジケースへの対応
references/
必要時に読み込む追加ドキュメントを配置します。
REFERENCE.mdFORMS.md- 分野別ファイル(
finance.md、legal.mdなど)
assets/
静的リソースを配置します。
- テンプレート
- 画像
- データファイル
Progressive disclosure
スキルはコンテキスト効率を意識して設計してください。- Metadata: 起動時に
nameとdescriptionを全スキル分読み込み - Instructions: 有効化時に
SKILL.md本文全体を読み込み - Resources:
scripts/、references/、assets/などを必要に応じて読み込み
SKILL.md は 500 行未満を目安にし、詳細は別ファイルへ分割してください。
File references
スキル内の他ファイル参照は、スキルルートからの相対パスを使用します。SKILL.md
SKILL.md から 1 段程度の浅い参照構造を推奨します。
Validation
skills-ref を使ってスキルを検証できます。SKILL.md frontmatter の妥当性と命名規則をチェックします。