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

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

対象: ServerRpc(Client に紐づくサーバー全体の操作) RPC 全体の概要とページ一覧は RPC を参照してください。

Runtime・Host のライフサイクル(experimental)

host.unpublishSession() は、所有する稼働中のホストから application publication を撤回します。公開を撤回しても、元のセッション履歴、worktree、実行中の作業は削除・停止されません。すでに公開されていない場合は unpublished が false になり、application 以外の publication はエラーになります。
host.dispose() は hostId を指定してホストリスナーを破棄します。
host.setSessionCreationPolicy() は、稼働中のホストでリモートの新規セッション受付を切り替えます。既存クライアントを切断せず、その後の受付だけに適用します。
SDKが起動したstdioランタイムでは、Client::stop() がセッションを切断した後、JSON-RPC接続とプロセスを閉じる前に runtime.shutdown を呼び出します。セッションの切断(session.detach)は全セッションで合計10秒の期限を共有し、期限を過ぎた切断はエラーとして戻り値に含めたうえで停止処理を続けます。ランタイムのクリーンアップ完了も最大10秒待ち、失敗時はエラーを戻り値に含めたうえで残りの停止処理を続けます。cli_url など外部ランタイムへの接続では、共有ランタイムを終了しないようこのRPCを呼び出しません。 CLIが対応するリクエストを特定できずid: nullのJSON-RPCエラーを返した場合、実行中のリクエストはすべて、引用値を除去して長さを制限した診断メッセージを含むJsonRpcExceptionで失敗します。接続は維持されますが、CLIがリクエストを処理済みの可能性もあるため、安全性を確認せずに自動再試行しないでください。CLIが読み取れない127階層を超える送信リクエストは送信前に拒否し、深すぎるハンドラー応答はJSON-RPCエラーに置き換えます。

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

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

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

taskAnalytics()->classifyTrajectory()はセッションを作成せず、記録済みのCopilotイベントまたはATIFデータを分類します。アーカイブされたツールは実行されず、会話履歴や分類テレメトリにも追加されません。eventsは入力順のまま渡し、classifiers、maxConcurrentRequests、judge、previousResultを指定できます。validateOnly: trueなら推論せず、ローカル検証結果だけを取得できます。 通常の分類では、イベント内容はGitHub CAPIの認証情報を使ったモデル処理に送られます。自動的な秘匿化やプロンプトインジェクション対策はないため、送信を承認したうえでアーカイブの出所を検証し、必要な機密情報を事前に除去してください。分類結果は信頼できる事実ではなく、認可やセキュリティ判断には使用しないでください。
認証URLのブラウザ起動には runtime()->openBrowser() を使います。
サンドボックスのパス許可警告は sandbox()->getPathGrantWarning() で取得します。

sessions connect・Remote Control(TCP モード)

CLIサーバーから既存のリモートセッションに接続する場合は、sessions()->connect()を使います。接続先のリモートsessionIdを渡すと、SDK側のsessionIdとリモートセッションのmetadataを含む結果が返ります。
TCPモードではsessions()からランタイム全体で1つのRemote Controlも管理できます。セッション単位のremote()->enable()とは異なり、操作対象セッションの開始・停止・移譲や、現在の状態の取得ができます。
詳細は Remote Sessions を参照してください。
最終更新日 2026年11月19日