skill-creator について
再利用可能なエージェントスキルの作成ガイドです。構成、命名、内容、参照、登録の規則を示し、汎用またはプロジェクト固有のスキルを作るコントリビューター、特にProwlerリポジトリでの利用を想定しています。
主な機能
- 01スキル作成の判断基準
- 02SKILL.mdの構成と項目
- 03命名規則
- 04assetsとreferencesの使い分け
- 05内容ガイドとチェックリスト
- 06AGENTS.mdへの登録
活用シーン
- 01再利用可能なプロジェクトスキルの作成
- 02assetsとreferencesの選択
- 03スキルの起動条件とメタデータの定義
- 04エージェント向けスキルの登録
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ prowler-cloud/ prowler --skill skill-creatorインストール後、Claude Code で/skill-creatorを入力して読み込まれたか確認します。
同梱ファイルassets/SKILL-TEMPLATE.md
詳細
スキルを作成するタイミング
次の場合はスキルを作成します。
- パターンが繰り返し使用され、AI にガイダンスが必要な場合
- プロジェクト固有の規約が一般的なベストプラクティスと異なる場合
- 複雑なワークフローに段階的な手順が必要な場合
- AI が適切なアプローチを選ぶための決定木が役立つ場合
次の場合はスキルを作成しないでください。
- すでにドキュメントがある場合(代わりにリファレンスを作成します)
- パターンが自明である場合
- 一度限りのタスクである場合
スキルの構成
skills/{skill-name}/
├── SKILL.md # Required - main skill file
├── assets/ # Optional - templates, schemas, examples
│ ├── template.py
│ └── schema.json
└── references/ # Optional - links to local docs
└── docs.md # Points to docs/developer-guide/*.mdx
SKILL.md のテンプレート
---
name: {skill-name}
description: >
{One-line description of what this skill does}.
Trigger: {When the AI should load this skill}.
license: Apache-2.0
metadata:
author: prowler-cloud
version: "1.0"
---
## When to Use
{Bullet points of when to use this skill}
## Critical Patterns
{The most important rules - what AI MUST know}
## Code Examples
{Minimal, focused examples}
## Commands
```bash
{Common commands}
```
## Resources
- **Templates**: See [assets/](assets/) for {description}
- **Documentation**: See [references/](references/) for local docs
命名規則
| 種類 | パターン | 例 |
|---|---|---|
| 汎用スキル | {technology} | pytest、playwright、typescript |
| Prowler 固有 | prowler-{component} | prowler-api、prowler-ui、prowler-sdk-check |
| テストスキル | prowler-test-{component} | prowler-test-sdk、prowler-test-api |
| ワークフロースキル | {action}-{target} | skill-creator、jira-task |
assets/ と references/ の使い分け
Need code templates? → assets/
Need JSON schemas? → assets/
Need example configs? → assets/
Link to existing docs? → references/
Link to external guides? → references/ (with local path)
重要なルール:references/ では、Web URL ではなくローカルファイル(docs/developer-guide/*.mdx)を参照します。
Prowler 固有と汎用の使い分け
Patterns apply to ANY project? → Generic skill (e.g., pytest, typescript)
Patterns are Prowler-specific? → prowler-{name} skill
Generic skill needs Prowler info? → Add references/ pointing to Prowler docs
Frontmatter のフィールド
| フィールド | 必須 | 説明 |
|---|---|---|
name | はい | スキル識別子(小文字、ハイフン区切り) |
description | はい | 目的とトリガーを 1 つのブロックに記述 |
license | はい | Prowler では常に Apache-2.0 |
metadata.author | はい | prowler-cloud |
metadata.version | はい | 文字列としてのセマンティックバージョン |
コンテンツのガイドライン
推奨事項
- 最も重要なパターンから始めます
- 決定木にはテーブルを使用します
- コード例は最小限にし、要点を絞ります
- コピーして使えるコマンドを含む Commands セクションを追加します
禁止事項
- Keywords セクションを追加しないでください(エージェントは本文ではなく frontmatter を検索します)
- 既存ドキュメントの内容を重複させないでください(代わりに参照します)
- 長い説明を含めないでください(ドキュメントへのリンクを使います)
- トラブルシューティングのセクションを追加しないでください(焦点を絞ります)
- references で Web URL を使用しないでください(ローカルパスを使います)
スキルの登録
スキルを作成したら、AGENTS.md に追加します。
| `{skill-name}` | {Description} | [SKILL.md](skills/{skill-name}/SKILL.md) |
作成前のチェックリスト
- スキルがまだ存在しないこと(
skills/を確認) - パターンを再利用できること(一度限りではない)
- 名前が規則に従っていること
- Frontmatter が完成していること(description にトリガーキーワードを含む)
- 重要なパターンが明確であること
- コード例が最小限であること
- Commands セクションがあること
- AGENTS.md に追加されていること
リソース
- テンプレート:SKILL.md のテンプレートは assets/ を参照してください
コメント
Markdown 対応