mcpField
U
update-skill

update-skill

github.com/warpdotdevエージェントワークフロー63628.4k 回インストール1 週間前に更新
リポジトリ

update-skill について

リポジトリ内でスキルを作成・更新するためのガイドです。`SKILL.md` の frontmatter、説明文、構成、ファイル整理を扱い、`skills-ref` による任意の検証も紹介します。

主な機能

  1. 01YAML frontmatter の要件
  2. 02スキル説明の作成ガイド
  3. 03推奨される文書構成
  4. 04参照ファイル分割のルール
  5. 05任意の `skills-ref` 検証

活用シーン

  1. 01リポジトリでのスキルの新規作成
  2. 02スキルの説明や構成の見直し
  3. 03詳細を参照ファイルへ移す判断

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/warpdotdev/common-skills --skill update-skill

インストール後、Claude Code で/update-skillを入力して読み込まれたか確認します。

同梱ファイルreferences/best-practices.md

詳細

update-skill

このガイドでは、このリポジトリでスキルを作成または更新する手順を説明します。スキルに必要な構成、フロントマター、ベストプラクティスを取り上げます。

クイックスタート

各スキルは、YAML フロントマターと Markdown 本文を含む SKILL.md ファイルが格納されたディレクトリです。

---
name: pdf-processing
description: Extract text and tables from PDF files, fill forms, merge documents.
---

# PDF Processing

## When to use this skill
Use this skill when the user needs to work with PDF files...

## How to extract text
1. Use pdfplumber for text extraction...

## How to fill forms
...

要件

フロントマター（必須）

すべての SKILL.md は、次の内容を含む YAML フロントマターで始める必要があります。

  • name：ケバブケースの識別子（小文字、数字、ハイフンのみ）
    • 例：add-feature-flag、pdf-processing、update-skill
  • description：スキルの内容と使用するタイミングを具体的に説明します
    • 空にすることはできません
    • スキルを見つけやすくするための主要な用語を含めます
    • スキルで実現できることを明確に示すため、動作を表す動詞から始めます（例：「機能を支援します」ではなく「機能フラグを追加します」）。続けて、具体的なユースケースや状況を示します（例：「機能フラグを扱うときに使用します」）
    • 三人称で記述します（例：「追加をお手伝いできます」ではなく「機能フラグを追加します」）
効果的な説明の書き方

description フィールドは、スキルを見つけやすくするうえで重要です。スキルの内容と使用するタイミングの両方を含めてください。適切な例をいくつか示します。

  • git-commit：「git diff を分析して、内容が分かりやすいコミットメッセージを生成します。ユーザーがコミットメッセージの作成やステージされた変更のレビューを求めたときに使用します。」
  • pdf-processing：「PDF ファイルからテキストや表を抽出し、フォームへの入力や文書の結合を行います。PDF ファイルを扱うときや、ユーザーが PDF、フォーム、文書の抽出に言及したときに使用します。」

「コードを支援します」や「開発タスクを行います」のような曖昧な説明は避けてください。詳しくは、references/best-practices.md の「説明のベストプラクティス」を参照してください。

スキルの構成

Warp のスキルにおける一般的なセクションは次のとおりです。

  1. タイトルと簡潔な概要 – スキルの目的と主なユースケースを明確に示すタイトルと簡潔な概要です。役立つ場合は、セクション、参考ファイル、関連スキルへのリンクを含めます
  2. 概要 - スキルの目的に関する背景情報です（任意ですが、一般的です）。概要を詳しく説明し、背景を補足します
  3. 主な内容 - 手順、使用方法、ワークフローのガイダンス
  4. ベストプラクティス - 指針と推奨事項（任意）
  5. 例／参考 PR - 実例へのリンク（任意）

スキルのニーズに合わせて、柔軟に構成してください。シンプルなスキルでは、任意のセクションを省略できます。

検証

任意で、skills-ref のリファレンスライブラリを使用して、スキルを検証できます。

skills-ref validate ./my-skill

この検証では、SKILL.md のフロントマターが有効で、命名規則に従っているかを確認します。インストールされていない場合は、WebSearch ツールを使ってこのパッケージの情報を調べてください。

主な内容に関するベストプラクティス
ファイルの整理
  • シンプルなスキル（200 行以下）：すべての内容を SKILL.md に記述します
  • 複雑なスキル（200 行超）：詳細な内容を references/ サブディレクトリに分割します
    • SKILL.md から、分かりやすいリンクで参考ファイルを参照します
    • 例：「詳しいガイダンスについては、references/best-practices.md を参照してください」

内容を分割するタイミング

次の場合は、references/ サブディレクトリを作成してください。

  • SKILL.md が 200 行以上になりそうな場合
  • スキルが、個別に読み込める複数の領域やワークフローを扱う場合
  • 詳細な参考資料によって、主な手順が煩雑になる場合

SKILL.md には、不可欠なワークフローと手順だけを残してください。詳細な参考資料、スキーマ、豊富な例は references/ ファイルに移してください。

既存のスキルの例

構成とスタイルの参考として、次の例をご覧ください。

  • .agents/skills/add-feature-flag/SKILL.md - 明確な順序で進める複数ステップのワークフロー
  • .agents/skills/remove-feature-flag/SKILL.md - 検索コマンドを使ったクリーンアップのワークフロー

ベストプラクティス

執筆に関する詳しいガイダンスは、references/best-practices.md をご覧ください。以下の内容を含みます。

  • 段階的に情報を開示するパターン
  • 簡潔で効果的な指示の書き方
  • コード例のフォーマット
  • 避けるべきよくあるアンチパターン

コメント

Markdown 対応