メインコンテンツへスキップ

ServerRpc 概要

対象: ServerRpc(Client に紐づくサーバー全体の操作) RPC 全体の概要とページ一覧は RPC を参照してください。 ServerRpc のメソッドをカテゴリー別にまとめた概要です。使用例は RPC の索引から機能別ページを参照してください。

接続・モデル・ツール・アカウント

ping()とconnect()で接続を確認・開始し、registerExtensionLaunchProvider()で拡張機能の起動プロバイダーを登録します。モデル一覧・価格単位・組み込みカタログはmodels()、利用可能なツール一覧はtools()から取得できます。account()ではクォータ、認証状態、ログインユーザーの一覧、ログイン・ログアウトを扱います。 providersConfig()->addModel()はサーバーの保存済みプロバイダー設定にモデルを追加する実験的なRPCです。プロバイダーが未保存の場合は作成され、providerAddedで確認できます。永続的な操作ですが、実行中のセッションは変更しません。 providersConfig の使用例は 設定・管理設定 を参照してください。

記録済みトラジェクトリの分類(experimental)

taskAnalytics()->classifyTrajectory()はセッションを作成せず、記録済みのCopilotイベントまたはATIFデータを分類します。アーカイブされたツールは実行されず、会話履歴や分類テレメトリにも追加されません。eventsは入力順のまま渡し、classifiers、maxConcurrentRequests、judge、previousResultを指定できます。validateOnly: trueなら推論せず、ローカル検証結果だけを取得できます。 使用例は セッション・ホスト・環境 を参照してください。

MCP・コネクター・Secrets

mcp()はMCP設定の一覧・追加・更新・削除、有効化、検出、レジストリ検索、インストール計画と適用を提供します。connectors()ではコネクター機能とアカウント、カタログを確認できます。サーバー側でのコネクター操作はアカウント単位の一覧取得・更新が中心です。実験的なsecrets()->addFilterValues()は、ホストが生成した動的シークレットをCLIのredaction filterに登録し、session logsやexportsでマスクします。 secrets の使用例は MCP・コネクター を参照してください。

Skills・Plugins・Agents・Instructions・Extensions

各グループから探索や利用可能なパスの取得、設定変更、再読み込みを行えます。commands()は組み込みコマンド一覧、hooks()はセッション開始前のフック探索を提供します。SkillsとPluginsは有効化・無効化やインストール管理に対応し、Agentsは組み込みエージェント情報も取得できます。Extensionsは永続化された拡張機能を探索・有効化・無効化します。lsp()ではサーバー全体の言語サーバー設定の一覧を取得できます。 使用例は Skills・Plugins・Agents・Instructions・Extensions を参照してください。

カタログとインストール

catalog()で候補検索・製品の推奨取得・選択・フィード取得を行い、Skills・Plugins・MCPの各APIでインストール計画の確認、適用、状態照会やキャンセルを行います。計画と適用は別操作です。実際のインストール例は後半の各項目を参照してください。

セッション・ホスト・実行環境

sessions()は永続化済みセッションの検索、イベント読み取り、サイズ確認、削除・整理、forkを扱います。Workspaceの作成・読み込みやリモート制御も利用できます。host()はホストの起動、セッション公開・一覧・公開解除、認証、受付ポリシー変更、破棄を行います。AHPホストの高レベルAPIはAHPホストを参照してください。runtime()はランタイムのライフサイクルを扱います。 sessions()->hasEvents()はセッションを開かず、ローカルの永続イベントログの有無を確認します。使用例は セッション・ホスト・環境 を参照してください。

クラウドエージェントタスク(experimental)

cloudTasks()はクラウドコーディングエージェントのタスク作成・削除・取得、セッションログやリプレイの取得、共有状態の変更、タスクIDから開くセッションの解決を行います。各メソッドは対応するParams型または配列を受け取り、結果を型付きDTOで返します。作成結果のokがfalseの場合、サービスによる拒否理由はreasonとmessage、実行されたHTTPリクエストの失敗情報はstatusCode、errorMessage、errorPayloadJsonで確認できます。 使用例は セッション・ホスト・環境 を参照してください。

Git・環境・サンドボックス・ポリシー

git()からブランチや作業ディレクトリ、Git remoteの情報を取得し、gitHubRepository()とgitHubOwners()からGitHubリポジトリや所有者を探索できます。environments()はMission Control環境、sandbox()とsandboxProxyCa()はサンドボックス対応状況やProxy CA、contentExclusion()は除外ポリシーの検証、managedSettings()とuserSettings()は設定を扱います。設定ファイルの個別キー削除と表示用の値のマスキングはsettings()から行えます。 gitHubRepository()->getById()はGitHubリポジトリIDからowner/nameを解決し、lookupBranchPullRequest()は指定したhead ownerとブランチを、優先順に指定したリポジトリで検索します。どちらもauthInfoをそのまま渡します。getById()の結果はrepositoryにowner/nameを含み、見つからない場合はnullです。Pull Request検索のstatusはfound、no-token、no-pr、lookup-failedのいずれかで、未知の値は文字列のまま保持されるため例外になりません。pullRequestは見つかった場合の連想配列で、それ以外はnullです。 gitHubRepository の使用例は Git・GitHub を参照してください。 gitHubFetch()は認証付きGitHub APIリクエストと名前付き操作を、gitHubRelease()はリリースの検索・スナップショット・資産ダウンロードと進捗確認を提供します。FetchではsessionIdでセッションの認証を選び、省略時はプロセスの認証が使われます。ホストが管理する認証バインディングを使う場合はauthOwnerIdを指定します。ReleaseのauthInfoはランタイムが管理する認証情報の選択子で、公開リリースの検索・ダウンロードは匿名でも実行できます。ダウンロード結果のpathは利用後に呼び出し側で削除してください。 FetchのallocateRequestId()、request()、executeOperation()と、ReleaseのabandonRequest()、getSnapshot()、downloadAsset()はExtensionsから呼び出せません。現在のLaravel SDKは両グループのcancel RPCを公開していないため、実行中の操作をSDKからキャンセルできません。abandonRequest()は未使用のRelease request IDを破棄する操作であり、実行中の操作を停止するものではありません。 fetch()は共有ネットワークトランスポートを使う汎用HTTPリクエスト用の実験的APIです。create()で接続所有のハンドルを作成し、必須のresponseModeを指定してsend()します。streamではread()で本文をチャンク単位に読み、textでは本文全体をUTF-8テキストとして取得し、fileではランタイムホスト上のdestinationPathへ本文を書き込みます。不要になったハンドルはcancel()で破棄します。認証情報を使わない場合、またはファイルをストリーミングする場合にも利用できます。

ローカルモデル・HTTP推論・ファイルシステム

azureMl()はローカルGPUメモリ情報の取得、モデルのカタログ・解決・ダウンロードと、その状態確認・キャンセル・削除を提供します。また、ファミリーリースを使ってAzure MLモデルのプロバイダー設定を登録・削除・復元できます。llmInference()はモデル層のHTTPリクエストをクライアント側へ中継する実験的APIです。sessionFs()はセッションのファイルシステム/SQLiteコールバックプロバイダーを登録します。 localModels()は接続単位の実験的APIで、モデル管理の設定・状態確認・変更監視、カタログ更新、モデルの準備・ダウンロード・更新・修復・削除、ジョブのキャンセル、通知の消去を行います。configure()、inspect()、watch()はLocalModelsViewとLocalModelsEvent[]を含む型付き結果を返します。watch()にはCancellationTokenを渡せます。トークンをキャンセルするとJSON-RPCのキャンセル通知を送信し、接続は維持されます。configure()のsessionIdはnullの場合に送信されません。

ネットワークコールバック(experimental)

network()->setProvider()で、クライアント側に登録したプロキシ解決・Kerberos認証コールバックをランタイムに通知します。通常はClientのnetworkオプションから自動登録されるため、直接呼び出す必要はありません。NetworkSetProviderRequestのコールバック項目は、対応するハンドラーが登録済みであることを示します。RPCの戻り値はありません。利用するランタイムはnetwork.setProvider RPCをサポートしている必要があり、未対応の場合はクライアント起動時に更新を案内する例外が発生します。 使用例は HTTP推論・ファイルシステム を参照してください。

内部・実験的な RPC

公式SDKで内部用とされる次のRPCも、Laravelでは@experimentalとして公開しています。将来変更・削除される可能性があり、ランタイムの呼び出し元制限も適用されます。エージェントレジストリの作成・一覧・削除、認証URLのブラウザ起動、期限切れの大きなツール出力の整理、サンドボックスのパス許可警告を利用できます。一覧結果には接続資格情報は含まれません。 使用例は モデル・ツール・アカウント、セッション・ホスト・環境、Skills・Plugins・Agents・Instructions・Extensions を参照してください。
最終更新日 2026年11月19日