エージェントを使用する GitHub Copilot Extensions のクイックスタート

GitHub の Blackbeard 拡張機能を構築して試し、GitHub Copilot Extensions の開発プロセスについて学習します。

この記事の内容

Blackbeard 拡張機能は、Copilot の大規模言語モデル (LLM) API と特別なシステム プロンプトを使って pirate のような要求に応答するシンプルなエージェントで構築された GitHub Copilot Extension です。 このガイドでは、簡素なエージェントの実装を使いますが、このプロセスはスキルセットに似ています。

このクイックスタートは、できるだけ早く 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 の一覧については、「Copilot 拡張機能の構築について」を参照してください。

Note

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 を使用すると、拡張機能ビルダーはコア機能の作成に重点を置き、定型コードに重点を置く必要がなくなりました。