既存の API から Microsoft 365 Copilot 用 API プラグインを構築する

重要

MCP および API プラグインは、 宣言型エージェント内でアクションを提供します。 これらはスタンドアロンのインストール可能なプラグインパッケージではなく、含まれているエージェントのみが機能とツールにアクセスできます。 パッケージとアクション マニフェストの関係の詳細については、「 プラグインと宣言型エージェント アクション」を参照してください。

ヒント

推奨事項: サポートされているプロコード宣言型エージェントとプラグイン シナリオ用の Work IQ 開発ツール から始めます。 WIQD クイックスタートを参照してください。 Toolkit ベースの手順は、それらを必要とする既存のプロジェクトおよびワークフローで引き続き使用できます。 ツールを選択する前に 、機能とターゲット エクスペリエンスのサポート を確認します。WIQD はカスタム エンジン エージェントを対象としません。

API プラグインを使用すると 、宣言型エージェントが既存の REST API を呼び出すことができます。 Microsoft 365 Agents Toolkit を使用して、API の OpenAPI 仕様に基づいて API アクションが統合されたエージェント プロジェクトを作成します。

前提条件

ヒント

最適な結果を得るには、OpenAPI 仕様が、「 Copilot の拡張で OpenAPI ドキュメントを効果的にする方法」で詳しく説明されているガイドラインに従っていることを確認してください。

このガイドに従うには、 Budget Tracker サンプル API をダウンロードし、ローカル開発マシンで実行するように構成します。 サンプルを少なくとも 1 回ビルドして、API の BudgetTracker.json ファイルを生成します。

エージェントと API プラグインを作成する

注

この記事のスクリーンショットとユーザー インターフェイス リファレンスでは、リリース版の Microsoft 365 Agents Toolkit を使用しています。 プレリリース版は、表示されているユーザー インターフェイスとは異なる場合があります。

API プラグインの構成には、次のものが含まれます。

  • REST API の OpenAPI 仕様。
  • 付属の OpenAPI 仕様を参照し、使用可能な操作、認証方法、応答形式を記述する プラグイン マニフェスト 。

これらのファイルを、このファイルを含むエージェントのアプリ パッケージに、アプリ マニフェスト、エージェント定義、アイコンと共に含めます。 API プラグイン マニフェスト自体は、インストール可能なパッケージではありません。

  1. Visual Studio Code を開きます。 Agents Toolkit がまだインストールされていない場合は、インストール手順については Agents Toolkit のインストール を参照してください。

  2. 左側のアクティビティ バーにある Microsoft 365 Agents Toolkit アイコンを選択します。

  3. [エージェント ツールキット] 作業ウィンドウで [ 新しいエージェント/アプリの作成 ] を選択します。

    Agents Toolkit インターフェイスのスクリーンショット

  4. 宣言型エージェントを選択します。

  5. [ アクションの追加] を選択し、[ OpenAPI の説明ドキュメントで開始する] を選択します。

  6. [ 参照 ] を選択し、予算トラッカー サンプルから OpenAPI 仕様の場所を参照します (./openapi/BudgetTracker.json)。

  7. プラグインに対して有効にするすべての操作を選択します。

    操作を選択するエージェント ツールキット UI

  8. エージェント プロジェクトの場所を選択します。

  9. エージェント プロジェクトの名前として Budget Tracker を入力します。

これらの手順を完了すると、Agents Toolkit によってエージェント プロジェクトとその API プラグイン構成が生成され、新しい Visual Studio Code ウィンドウでプロジェクトが開きます。

注

コード交換用証明キー (PKCE) は既定で有効になっています。 ID サーバーが PKCE をサポートしていない場合は、エージェント プロジェクトで m365agents.yml に次の行を追加して無効にします。

isPKCEEnabled: false

エージェントのプロビジョニングとサイドロード

サイドローディングにより、含まれるエージェントとその API アクションが開発テストに利用できるようになります。 API プラグインは、独立した機能としてインストールされません。 この手順は、構成されたプラグイン パッケージの一般的な配布方法ではありません。 ルートの共有と公開については、「 プラグインの公開と配布方法を選択する」を参照してください。

  1. Visual Studio Code でエージェント プロジェクトを開きます。

  2. 左側のアクティビティ バーにある Microsoft 365 Agents Toolkit アイコンを選択します。

  3. [ アカウント] ウィンドウで、[ Microsoft 365 にサインインする] を選択します。 (すでにサインインしている場合は、次の手順に進みます)。

  4. Microsoft 365 アカウントの下に、[ カスタム アプリのアップロードが有効] と [Copilot アクセスが有効] の両方が表示されていることを確認します。 そうでない場合は、organization 管理者にチェックしてください。詳細については、「Copilot 拡張性オプションの要件」を参照してください。

  5. [ ライフサイクル ] ウィンドウで、[ プロビジョニング] を選択します。

  6. OAuth 登録用のクライアント ID を入力してください...、プラグイン クライアント ID を入力します。

  7. OAuth 登録用のクライアント シークレットを入力してください...、プラグイン クライアント シークレットを入力します。

  8. ダイアログ ボックスのメッセージを読み、[ 確認 ] を選択して続行します。

  9. プロビジョニングが完了したことをツールキットからレポートされるまで待ちます。

    プロビジョニングの成功を確認するエージェント ツールキット メッセージ

これで、エージェントが Microsoft Teams の Microsoft 365 Copilot のユーザー アカウントでテストできるようになります。

エージェントの API アクションをテストする

  1. ブラウザーで Teams を開き、エージェントのサイドロードに使用した Microsoft 365 アカウントでサインインします。

  2. 左側のアクティビティ バーで [Chat] を選択します。

  3. [Chat] ウィンドウで [Copilot] を選択します。

  4. 右側の [エージェント] リストで [ 予算トラッカー ] を選択します。 一覧が表示されない場合は、右上隅にある [Copilot チャットなど ] アイコンを選択します。

    Microsoft Teams のエージェント リストのスクリーンショット

  5. 予算について質問します。 たとえば、 How much is left in the Fourth Coffee lobby renovation budget? を試してください。 メッセージが表示されたら、[ 常に許可 ] または [一度許可] を選択して続行します。

  6. サインインを求められたら、[ 予算トラッカーにサインイン] を選択します。