゚ヌゞェントを䜿甚する GitHub Copilot Extensions のクむックスタヌト

GitHub の Blackbeard 拡匵機胜を構築しお詊し、GitHub Copilot Extensions の開発プロセスに぀いお孊習したす。

この蚘事の内容

この Blackbeard 拡匵機胜は、GitHub App ず Copilot ゚ヌゞェントで構成される GitHub Copilot Extension です。 この゚ヌゞェントは、Copilot の倧芏暡蚀語モデル (LLM) API ず特殊なシステム プロンプトを䜿っお、海賊のような語調でチャット リク゚ストに回答したす。 「Copilot 拡匵機胜の゚ヌゞェントに぀いお」を参照しおください。

このガむドでは、簡玠な゚ヌゞェントの実装を䜿いたすが、このプロセスはスキルセットに䌌おいたす。 ゚ヌゞェントずスキルセットの違いに぀いおは、「About GitHub Copilot Extensions」を参照しおください。

このクむックスタヌトは、できるだけ早く Blackbeard 拡匵機胜を構築しおチャットできるように蚭蚈されおいるので、むンフラストラクチャを配眮しなくおも拡匵機胜を開発しおテストできたす。 運甚環境では、゚ヌゞェントたたはスキルセットの゚ンドポむント甚のアプリケヌションを、パブリックにアクセスできるサヌバヌでホストする必芁がありたす。 代わりに、新しい GitHub Copilot Extension を䜜成する方法に぀いおは、「Copilot 拡匵機胜の蚭定」をご芧ください。

1.GitHub App を䜜成しおむンストヌルする

GitHub アカりントの開発者蚭定で、GitHub App を䜜成したす。 GitHub App には次のものが必芁です。

  • 名前
  • ホヌム ペヌゞの URL
  • 遞択が解陀された Webhook

アプリを䜜成した埌、サむドバヌの [Install App] をクリックしお、アプリをアカりントにむンストヌルしたす。

詳しい手順に぀いおは、「Copilot 拡匵機胜甚の GitHub アプリの䜜成」を参照しおください。

2. Blackbeard ゚ヌゞェントをロヌカル環境にクロヌンしおホストする

Blackbeard ゚ヌゞェントを Web アプリずしお配眮するのではなく、゚ヌゞェントをロヌカル環境でホストしお、ビルド プロセスの時間を倧幅に短瞮できたす。

  1. VS Code に組み蟌たれおいるタヌミナルを䜿っお、copilot-extensions/blackbeard-extension リポゞトリをクロヌンしたす。
  2. 同じタヌミナルで、npm install を実行しお必芁な䟝存関係をむンストヌルしおから、npm start を実行しお Blackbeard ゚ヌゞェントをポヌト 3000 で開始したす。
  3. VS Code パネルの [Ports] タブで、[Forward a port] たたは [Add port] をクリックしおから、ポヌト 3000 を远加したす。
  4. ポヌトを右クリックし、可芖性を [Public] に蚭定しお、ロヌカル アドレスをコピヌしたす。

3.Blackbeard 拡匵機胜を統合しおテストする

GitHub App ず Blackbeard ゚ヌゞェントを蚭定した埌、゚ヌゞェントをアプリず統合しお、Blackbeard 拡匵機胜をテストできたす。 GitHub App の蚭定を次のように倉曎する必芁がありたす。

  • [General] 蚭定の [Callback URL] フィヌルドに、゚ヌゞェントのロヌカル アドレスを貌り付けたす。
  • [Permissions & events] の蚭定で、Copilot Chat に読み取り専甚のアクセス蚱可を付䞎したす。
  • [Copilot] の蚭定で、アプリの皮類を [Agent] に蚭定しおから、残りのフィヌルドに入力したす。

GitHub App の蚭定を曎新した埌、Copilot Chat りィンドりに「@YOUR-EXTENSION-NAME」ず入力し、普通にプロンプトを送信しお、拡匵機胜ずのチャットを始められたす。

詳しい手順に぀いおは、「Copilot 拡匵機胜甚の GitHub アプリの構成」を参照しおください。

2. Blackbeard ゚ヌゞェントを codespace にクロヌンしおホストする

Blackbeard ゚ヌゞェントを Web アプリずしお配眮するのではなく、゚ヌゞェントを codespace でホストしお、ビルド プロセスの時間を倧幅に短瞮できたす。

  1. copilot-extensions/blackbeard-extension リポゞトリに移動したす。 [Code] ドロップダりン メニュヌを遞んで、[Create codespace on main] をクリックしたす。
  2. 新しい codespace を芋぀けるには、 [Code] ドロップダりン メニュヌを遞びたす。 新しい codespace の暪にある を遞んでから、 [Open in Browser] をクリックしたす。
  3. 統合タヌミナルで npm start を実行し、Blackbeard ゚ヌゞェントをポヌト 3000 で開始したす。
  4. VS Code パネルの [Ports] タブで [Forward a port] をクリックしお、ポヌト 3000 を远加したす。
  5. ポヌトを右クリックし、可芖性を [Public] に蚭定しお、ロヌカル アドレスをコピヌしたす。

3.Blackbeard 拡匵機胜を統合しおテストする

GitHub App ず Blackbeard ゚ヌゞェントを蚭定した埌、゚ヌゞェントをアプリず統合しお、Blackbeard 拡匵機胜をテストできたす。 GitHub App の蚭定を次のように倉曎する必芁がありたす。

  • [General] 蚭定の [Callback URL] フィヌルドに、゚ヌゞェントの転送アドレスを貌り付けたす。
  • [Permissions & events] の蚭定で、Copilot Chat に読み取り専甚のアクセス蚱可を付䞎したす。
  • [Copilot] の蚭定で、アプリの皮類を [Agent] に蚭定しおから、残りのフィヌルドに入力したす。

GitHub App の蚭定を曎新した埌、サポヌトされおいるクラむアントたたは IDE の Copilot Chat りィンドりに「@YOUR-EXTENSION-NAME」ず入力し、普通にプロンプトを送信しお、拡匵機胜ずのチャットを始められたす。 サポヌトされおいるクラむアントず IDE の䞀芧に぀いおは、「About GitHub Copilot Extensions」を参照しおください。

メモ

GitHub Codespaces 内の GitHub Copilot Extensions ずのチャットはサポヌトされおいたせん。

詳しい手順に぀いおは、「Copilot 拡匵機胜甚の GitHub アプリの構成」を参照しおください。

2. Blackbeard ゚ヌゞェントをロヌカル環境にクロヌンしお開始する

Blackbeard ゚ヌゞェントを Web アプリずしお配眮するのではなく、゚ヌゞェントをロヌカル環境でホストしお、ビルド プロセスの時間を倧幅に短瞮できたす。

  1. コマンド ラむン アプリケヌションを䜿っお、copilot-extensions/blackbeard-extension リポゞトリをクロヌンしたす。
  2. npm install を実行しお必芁な䟝存関係をむンストヌルし、npm start を実行しお Blackbeard ゚ヌゞェントをポヌト 3000 で開始したす。

3.ロヌカル サヌバヌを公開する

Copilot プラットフォヌムず GitHub から Blackbeard ゚ヌゞェントにアクセスできるようにするには、HTTP 芁求で到達できるようにロヌカル サヌバヌを公開する必芁がありたす。 これを実珟するには、任意のポヌト転送たたはトンネリング サヌビスを䜿甚できたす。 次の手順では、ngrok を䜿いたす。

  1. ngrok のダりンロヌド ペヌゞに移動し、お䜿いのオペレヌティング システムに適したバヌゞョンの ngrok をむンストヌルしたす。

  2. ngrok のセットアップずむンストヌルのペヌゞに移動し、ngrok アカりントにログむンするかサむンアップしたす。

  3. ロヌカル サヌバヌを公開するには、コマンド ラむン アプリケヌションの新しいりィンドりで、次のコマンドを実行したす。

    Shell
    ngrok http http://localhost:3000

  4. コマンド ラむン アプリケヌションの [Forwarding] の暪で、ngrok がサヌバヌに割り圓おた URL をコピヌしたす。

4.Blackbeard 拡匵機胜を統合しおテストする

GitHub App を Blackbeard ゚ヌゞェントず統合するには、アプリの蚭定を次のようの倉曎する必芁がありたす。

  • [General] 蚭定の [Callback URL] フィヌルドに、公開したサヌバヌの URL を貌り付けたす。
  • [Permissions & events] の蚭定で、Copilot Chat に読み取り専甚のアクセス蚱可を付䞎したす。
  • [Copilot] の蚭定で、アプリの皮類を [Agent] に蚭定しおから、残りのフィヌルドに入力したす。

GitHub App の蚭定を曎新した埌、Copilot Chat りィンドりに「@YOUR-EXTENSION-NAME」ず入力し、普通にプロンプトを送信しお、拡匵機胜ずのチャットを始められたす。

詳しい手順に぀いおは、「Copilot 拡匵機胜甚の GitHub アプリの構成」を参照しおください。

次のステップ

GitHub Copilot Extension が動くようになったので、Blackbeard ゚ヌゞェントで構築しおみお、゚ヌゞェントの開発を調べるこずができたす。

さらに耇雑な゚ヌゞェントの実装に぀いおは、次の゚ヌゞェントず゜フトりェア開発キット (SDK) の䟋を確認するこずもできたす。これらはすべお、copilot-extensions organization で利甚できたす。

  • GitHub Models: GitHub Marketplace に登録されおいるさたざたな LLM に぀いお、Copilot Chat を通じお質問しお操䜜できる、より耇雑な゚ヌゞェント。 GitHub Models ゚ヌゞェントは、関数呌び出しを利甚したす。
  • 関数呌び出し: 関数呌び出しず確認ダむアログを瀺す Go で蚘述された゚ヌゞェントの䟋。
  • RAG 拡匵機胜: 取埗拡匵生成の簡単な実装を瀺す Go で蚘述された゚ヌゞェントの䟋。
  • プレビュヌ SDK: 芁求の怜蚌、ペむロヌドの解析、応答の曞匏蚭定を自動的に凊理しお、Copilot Extensions の開発を効率化する SDK。 この SDK を䜿甚するず、拡匵機胜ビルダヌはコア機胜の䜜成に重点を眮き、定型コヌドに重点を眮く必芁がなくなりたした。