skill-name について
エージェントスキルの作成と文書化に使うテンプレートです。セットアップ、コマンド、例、スクリプト、トラブルシューティング、参考資料の項目を備え、完成済みのスキルではなく作成の出発点となります。
主な機能
- 01前提条件と設定の記載
- 02クイックスタートコマンドの追加
- 03スクリプトとコマンドの説明
- 04使用例の記載
- 05トラブル対応と参考資料の整理
活用シーン
- 01新しいスキルディレクトリの作成
- 02スキル文書の構成
- 03スクリプトとワークフロー例の一覧化
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ resciencelab/ opc-skills --skill skill-nameインストール後、Claude Code で/skill-nameを入力して読み込まれたか確認します。
詳細
スキル名
スキルの概要と目的を簡潔に説明します。
前提条件
必要なセットアップ要件を列挙します。
- 必要な環境変数
- 必要な API キー
- 依存関係(上記のフロントマターにすでに記載されています)
セットアップ例:
export SKILL_API_KEY="your_api_key"
クイックスタート
スキルをすぐに使う方法:
cd <skill_directory>
python3 scripts/command.py --option value
使用例
例 1:基本的な使い方
python3 scripts/script.py "input"
出力:
Expected output here
例 2:応用的な使い方
python3 scripts/script.py "input" --flag --option value
コマンド
すべてのコマンドはスキルのディレクトリから実行します。
コマンド 1
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value
コマンド 2
python3 scripts/script2.py "param1" "param2"
スクリプト
script1.py- このスクリプトの機能の説明script2.py- このスクリプトの機能の説明
API 情報
- ベース URL:(該当する場合)
- レート制限:(該当する場合)
- 認証:認証の仕組み
- ドキュメント:公式ドキュメントへのリンク
トラブルシューティング
問題 1
症状:問題の説明
解決方法:
- 手順 1
- 手順 2
問題 2
症状:問題の説明
解決方法:
- 手順 1
- 手順 2
例
ワークフローの全例については、examples/ ディレクトリを参照してください。
参考資料
注意事項
- 重要な注意事項 1
- 重要な注意事項 2
フロントマターガイド
このファイルの先頭に YAML フロントマターが必要です。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
name | string | ✓ | 一意の識別子(ケバブケース) |
description | string | ✓ | スキルの機能と使用する場面を説明します。トリガーキーワードと「次のような場面で使用する」という文脈を含めてください。 |
スキルの作成
- このテンプレートを
skills/your-skill-name/にコピーします - YAML フロントマターを更新します
- SKILL.md のドキュメントを作成します
- Python/シェルスクリプトを
scripts/に追加します - 使用例を
examples/に追加します skills.jsonにスキルのエントリーを追加します- PR を提出する前に、使用するエージェントでテストします
コメント
Markdown 対応