heydeer
HeyDeer にコードベースを教える

スキル

スキルは、ルートのアクセス制御の検証方法など、再利用可能な手順をオープンな Agent Skills フォーマットで記述したものです。リポジトリのチェックに必要なスキルを指定すると、HeyDeer はそのチェックを実行する際にそのスキルに従います。

スキルを追加する

  1. .agents/skills/ にフォルダーを作成します。フォルダー名がスキル名になります(api-auth など)。
  2. フォルダーに SKILL.md を追加します。Agent Skills フォーマットの要件どおり、ファイルの先頭にはフロントマターを置き、name にフォルダー名と同じ名前を、description にスキルを使う場面の説明を書きます。
  3. フロントマターの下に手順を書きます。
  4. スキルを必要とする各チェックの skills に、そのスキルを記載します。

.agents/skills/api-auth/SKILL.md

---
name: api-auth
description: How route handlers authenticate and authorize requests.
  Use when checking a route's access control.
---
# Checking a route's access control

1. Find the handler in src/routes/ and the middleware its router
   applies.
2. requireAuth() from src/auth/middleware.ts must run before the
   handler reads the request.
3. Routes under /admin also need requireRole('admin').
4. A handler that takes an :orgId parameter calls
   assertMember(user, orgId) before its first query.

Routes listed in src/routes/public.ts are public by design.
  • スキル名には英小文字、数字、ハイフン(連続不可)を使用でき、64 文字以内です。
  • 各スキルは SKILL.md を含むフォルダーです。HeyDeer は、SKILL.md が参照するファイルも含め、Agent Skills フォーマットの仕様どおりにフォルダー全体を読み込みます。
  • HeyDeer はスキルをプルリクエストから読み込むため、プルリクエストは自身のレビューに使われるスキルを追加・変更できます。プルリクエストで変更できるものを参照してください。

チェックでスキルを指定する

チェックのフロントマターの skills に、スキル名を 1 つ、またはリストで追加します:

.agents/checks/route-auth.md

---
files: "src/routes/**"
skills: [api-auth]
---
Every new or changed route handler checks authentication and
authorization before it reads the request.
  • スキルはあくまでガイダンスです。指定したスキルが見つからない場合でも、HeyDeer はチェックの指示に基づいてチェックを実行します。
  • 対象ファイルに一致するチェックに無効なスキル名が含まれている場合、そのチェックは無効です。HeyDeer はそのチェックをスキップし、レビューの注意事項に記載して、レビューを続行します。

.claude/skills をすでに使っている場合

シンボリックリンクを追加して、同じスキルを .agents/skills にも配置します。スキルを移動する必要はありません:

mkdir -p .agents
ln -s ../.claude/skills .agents/skills
git add .agents/skills