@github/copilot-sdk 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -38,7 +38,7 @@ const session = await client.createSession({
     onPermissionRequest: approveAll,
 });
 
-// Wait for response using typed event handlers
+// Wait for the response using typed event handlers
 const done = new Promise<void>((resolve) => {
     session.on("assistant.message", (event) => {
         console.log(event.data.content);

package/dist/cjs/client.js

@@ -36,6 +36,11 @@ var import_sessionFsProvider = require("./sessionFsProvider.js");
 var import_telemetry = require("./telemetry.js");
 var import_types = require("./types.js");
 const import_meta = {};
+function toWireProviderConfig(provider) {
+  const { maxInputTokens, ...rest } = provider;
+  if (maxInputTokens === void 0) return rest;
+  return { ...rest, maxPromptTokens: maxInputTokens };
+}
 const MIN_PROTOCOL_VERSION = 2;
 function isZodSchema(value) {
   return value != null && typeof value === "object" && "toJSONSchema" in value && typeof value.toJSONSchema === "function";
@@ -230,7 +235,8 @@ class CopilotClient {
       useLoggedInUser: options.useLoggedInUser ?? (options.gitHubToken ? false : true),
       telemetry: options.telemetry,
       copilotHome: options.copilotHome,
-      sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0
+      sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0,
+      remote: options.remote ?? false
     };
   }
   /**
@@ -524,6 +530,12 @@ class CopilotClient {
     if (config.onElicitationRequest) {
       session.registerElicitationHandler(config.onElicitationRequest);
     }
+    if (config.onExitPlanMode) {
+      session.registerExitPlanModeHandler(config.onExitPlanMode);
+    }
+    if (config.onAutoModeSwitch) {
+      session.registerAutoModeSwitchHandler(config.onAutoModeSwitch);
+    }
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
@@ -569,11 +581,14 @@ class CopilotClient {
         systemMessage: wireSystemMessage,
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
-        provider: config.provider,
+        provider: config.provider ? toWireProviderConfig(config.provider) : void 0,
+        enableSessionTelemetry: config.enableSessionTelemetry,
         modelCapabilities: config.modelCapabilities,
         requestPermission: true,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,
+        requestExitPlanMode: !!config.onExitPlanMode,
+        requestAutoModeSwitch: !!config.onAutoModeSwitch,
         hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)),
         workingDirectory: config.workingDirectory,
         streaming: config.streaming,
@@ -652,6 +667,12 @@ class CopilotClient {
     if (config.onElicitationRequest) {
       session.registerElicitationHandler(config.onElicitationRequest);
     }
+    if (config.onExitPlanMode) {
+      session.registerExitPlanModeHandler(config.onExitPlanMode);
+    }
+    if (config.onAutoModeSwitch) {
+      session.registerAutoModeSwitchHandler(config.onAutoModeSwitch);
+    }
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
@@ -686,6 +707,7 @@ class CopilotClient {
         systemMessage: wireSystemMessage,
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
+        enableSessionTelemetry: config.enableSessionTelemetry,
         tools: config.tools?.map((tool) => ({
           name: tool.name,
           description: tool.description,
@@ -697,11 +719,13 @@ class CopilotClient {
           name: cmd.name,
           description: cmd.description
         })),
-        provider: config.provider,
+        provider: config.provider ? toWireProviderConfig(config.provider) : void 0,
         modelCapabilities: config.modelCapabilities,
         requestPermission: config.onPermissionRequest !== import_types.defaultJoinSessionPermissionHandler,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,
+        requestExitPlanMode: !!config.onExitPlanMode,
+        requestAutoModeSwitch: !!config.onAutoModeSwitch,
         hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)),
         workingDirectory: config.workingDirectory,
         configDir: config.configDir,
@@ -857,7 +881,7 @@ class CopilotClient {
       );
       serverVersion = result.protocolVersion;
     } catch (err) {
-      if (err instanceof import_node.ResponseError && err.code === import_node.ErrorCodes.MethodNotFound) {
+      if (err instanceof import_node.ResponseError && (err.code === import_node.ErrorCodes.MethodNotFound || err.message === "Unhandled method connect")) {
         serverVersion = (await raceAgainstExit(this.ping())).protocolVersion;
       } else {
         throw err;
@@ -1092,6 +1116,9 @@ class CopilotClient {
           this.options.sessionIdleTimeoutSeconds.toString()
         );
       }
+      if (this.options.remote) {
+        args.push("--remote");
+      }
       const envWithoutNodeDebug = { ...this.options.env };
       delete envWithoutNodeDebug.NODE_DEBUG;
       if (this.options.gitHubToken) {
@@ -1323,6 +1350,14 @@ stderr: ${stderrOutput}`
       "userInput.request",
       async (params) => await this.handleUserInputRequest(params)
     );
+    this.connection.onRequest(
+      "exitPlanMode.request",
+      async (params) => await this.handleExitPlanModeRequest(params)
+    );
+    this.connection.onRequest(
+      "autoModeSwitch.request",
+      async (params) => await this.handleAutoModeSwitchRequest(params)
+    );
     this.connection.onRequest(
       "hooks.invoke",
       async (params) => await this.handleHooksInvoke(params)
@@ -1389,6 +1424,35 @@ stderr: ${stderrOutput}`
     });
     return result;
   }
+  async handleExitPlanModeRequest(params) {
+    if (!params || typeof params.sessionId !== "string" || typeof params.summary !== "string" || !Array.isArray(params.actions) || typeof params.recommendedAction !== "string") {
+      throw new Error("Invalid exit plan mode request payload");
+    }
+    const session = this.sessions.get(params.sessionId);
+    if (!session) {
+      throw new Error(`Session not found: ${params.sessionId}`);
+    }
+    return await session._handleExitPlanModeRequest({
+      summary: params.summary,
+      planContent: params.planContent,
+      actions: params.actions,
+      recommendedAction: params.recommendedAction
+    });
+  }
+  async handleAutoModeSwitchRequest(params) {
+    if (!params || typeof params.sessionId !== "string") {
+      throw new Error("Invalid auto mode switch request payload");
+    }
+    const session = this.sessions.get(params.sessionId);
+    if (!session) {
+      throw new Error(`Session not found: ${params.sessionId}`);
+    }
+    const response = await session._handleAutoModeSwitchRequest({
+      errorCode: params.errorCode,
+      retryAfterSeconds: params.retryAfterSeconds
+    });
+    return { response };
+  }
   async handleHooksInvoke(params) {
     if (!params || typeof params.sessionId !== "string" || typeof params.hookType !== "string") {
       throw new Error("Invalid hooks invoke payload");

package/dist/cjs/generated/rpc.js

@@ -176,6 +176,11 @@ function createSessionRpc(connection, sessionId) {
     /** @experimental */
     usage: {
       getMetrics: async () => connection.sendRequest("session.usage.getMetrics", { sessionId })
+    },
+    /** @experimental */
+    remote: {
+      enable: async () => connection.sendRequest("session.remote.enable", { sessionId }),
+      disable: async () => connection.sendRequest("session.remote.disable", { sessionId })
     }
   };
 }

package/dist/cjs/session.js

@@ -49,6 +49,8 @@ class CopilotSession {
   permissionHandler;
   userInputHandler;
   elicitationHandler;
+  exitPlanModeHandler;
+  autoModeSwitchHandler;
   hooks;
   transformCallbacks;
   _rpc = null;
@@ -444,6 +446,24 @@ class CopilotSession {
   registerElicitationHandler(handler) {
     this.elicitationHandler = handler;
   }
+  /**
+   * Registers the exit-plan-mode handler for this session.
+   *
+   * @param handler - The handler to invoke when the server dispatches an exit-plan-mode request
+   * @internal This method is typically called internally when creating/resuming a session.
+   */
+  registerExitPlanModeHandler(handler) {
+    this.exitPlanModeHandler = handler;
+  }
+  /**
+   * Registers the auto-mode-switch handler for this session.
+   *
+   * @param handler - The handler to invoke when the server dispatches an auto-mode-switch request
+   * @internal This method is typically called internally when creating/resuming a session.
+   */
+  registerAutoModeSwitchHandler(handler) {
+    this.autoModeSwitchHandler = handler;
+  }
   /**
    * Handles an elicitation.requested broadcast event.
    * Invokes the registered handler and responds via handlePendingElicitation RPC.
@@ -469,6 +489,26 @@ class CopilotSession {
       }
     }
   }
+  /**
+   * Handles an exitPlanMode.request callback from the runtime.
+   * @internal
+   */
+  async _handleExitPlanModeRequest(request) {
+    if (!this.exitPlanModeHandler) {
+      return { approved: true };
+    }
+    return await this.exitPlanModeHandler(request, { sessionId: this.sessionId });
+  }
+  /**
+   * Handles an autoModeSwitch.request callback from the runtime.
+   * @internal
+   */
+  async _handleAutoModeSwitchRequest(request) {
+    if (!this.autoModeSwitchHandler) {
+      return "no";
+    }
+    return await this.autoModeSwitchHandler(request, { sessionId: this.sessionId });
+  }
   /**
    * Sets the host capabilities for this session.
    *
@@ -749,6 +789,10 @@ class CopilotSession {
     this.typedEventHandlers.clear();
     this.toolHandlers.clear();
     this.permissionHandler = void 0;
+    this.userInputHandler = void 0;
+    this.elicitationHandler = void 0;
+    this.exitPlanModeHandler = void 0;
+    this.autoModeSwitchHandler = void 0;
   }
   /**
    * @deprecated Use {@link disconnect} instead. This method will be removed in a future release.

package/dist/cjs/types.js

@@ -51,9 +51,10 @@ function convertMcpCallToolResult(callResult) {
           textParts.push(block.resource.text);
         }
         if (block.resource?.blob) {
+          const mimeType = block.resource.mimeType;
           binaryResults.push({
             data: block.resource.blob,
-            mimeType: block.resource.mimeType ?? "application/octet-stream",
+            mimeType: typeof mimeType === "string" && mimeType ? mimeType : "application/octet-stream",
             type: "resource",
             description: block.resource.uri
           });

package/dist/client.d.ts

@@ -455,6 +455,8 @@ export declare class CopilotClient {
     private handleSessionEventNotification;
     private handleSessionLifecycleNotification;
     private handleUserInputRequest;
+    private handleExitPlanModeRequest;
+    private handleAutoModeSwitchRequest;
     private handleHooksInvoke;
     private handleSystemMessageTransform;
     /**

package/dist/client.js

@@ -22,6 +22,11 @@ import { CopilotSession, NO_RESULT_PERMISSION_V2_ERROR } from "./session.js";
 import { createSessionFsAdapter } from "./sessionFsProvider.js";
 import { getTraceContext } from "./telemetry.js";
 import { defaultJoinSessionPermissionHandler } from "./types.js";
+function toWireProviderConfig(provider) {
+  const { maxInputTokens, ...rest } = provider;
+  if (maxInputTokens === void 0) return rest;
+  return { ...rest, maxPromptTokens: maxInputTokens };
+}
 const MIN_PROTOCOL_VERSION = 2;
 function isZodSchema(value) {
   return value != null && typeof value === "object" && "toJSONSchema" in value && typeof value.toJSONSchema === "function";
@@ -216,7 +221,8 @@ class CopilotClient {
       useLoggedInUser: options.useLoggedInUser ?? (options.gitHubToken ? false : true),
       telemetry: options.telemetry,
       copilotHome: options.copilotHome,
-      sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0
+      sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0,
+      remote: options.remote ?? false
     };
   }
   /**
@@ -510,6 +516,12 @@ class CopilotClient {
     if (config.onElicitationRequest) {
       session.registerElicitationHandler(config.onElicitationRequest);
     }
+    if (config.onExitPlanMode) {
+      session.registerExitPlanModeHandler(config.onExitPlanMode);
+    }
+    if (config.onAutoModeSwitch) {
+      session.registerAutoModeSwitchHandler(config.onAutoModeSwitch);
+    }
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
@@ -555,11 +567,14 @@ class CopilotClient {
         systemMessage: wireSystemMessage,
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
-        provider: config.provider,
+        provider: config.provider ? toWireProviderConfig(config.provider) : void 0,
+        enableSessionTelemetry: config.enableSessionTelemetry,
         modelCapabilities: config.modelCapabilities,
         requestPermission: true,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,
+        requestExitPlanMode: !!config.onExitPlanMode,
+        requestAutoModeSwitch: !!config.onAutoModeSwitch,
         hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)),
         workingDirectory: config.workingDirectory,
         streaming: config.streaming,
@@ -638,6 +653,12 @@ class CopilotClient {
     if (config.onElicitationRequest) {
       session.registerElicitationHandler(config.onElicitationRequest);
     }
+    if (config.onExitPlanMode) {
+      session.registerExitPlanModeHandler(config.onExitPlanMode);
+    }
+    if (config.onAutoModeSwitch) {
+      session.registerAutoModeSwitchHandler(config.onAutoModeSwitch);
+    }
     if (config.hooks) {
       session.registerHooks(config.hooks);
     }
@@ -672,6 +693,7 @@ class CopilotClient {
         systemMessage: wireSystemMessage,
         availableTools: config.availableTools,
         excludedTools: config.excludedTools,
+        enableSessionTelemetry: config.enableSessionTelemetry,
         tools: config.tools?.map((tool) => ({
           name: tool.name,
           description: tool.description,
@@ -683,11 +705,13 @@ class CopilotClient {
           name: cmd.name,
           description: cmd.description
         })),
-        provider: config.provider,
+        provider: config.provider ? toWireProviderConfig(config.provider) : void 0,
         modelCapabilities: config.modelCapabilities,
         requestPermission: config.onPermissionRequest !== defaultJoinSessionPermissionHandler,
         requestUserInput: !!config.onUserInputRequest,
         requestElicitation: !!config.onElicitationRequest,
+        requestExitPlanMode: !!config.onExitPlanMode,
+        requestAutoModeSwitch: !!config.onAutoModeSwitch,
         hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)),
         workingDirectory: config.workingDirectory,
         configDir: config.configDir,
@@ -843,7 +867,7 @@ class CopilotClient {
       );
       serverVersion = result.protocolVersion;
     } catch (err) {
-      if (err instanceof ResponseError && err.code === ErrorCodes.MethodNotFound) {
+      if (err instanceof ResponseError && (err.code === ErrorCodes.MethodNotFound || err.message === "Unhandled method connect")) {
         serverVersion = (await raceAgainstExit(this.ping())).protocolVersion;
       } else {
         throw err;
@@ -1078,6 +1102,9 @@ class CopilotClient {
           this.options.sessionIdleTimeoutSeconds.toString()
         );
       }
+      if (this.options.remote) {
+        args.push("--remote");
+      }
       const envWithoutNodeDebug = { ...this.options.env };
       delete envWithoutNodeDebug.NODE_DEBUG;
       if (this.options.gitHubToken) {
@@ -1309,6 +1336,14 @@ stderr: ${stderrOutput}`
       "userInput.request",
       async (params) => await this.handleUserInputRequest(params)
     );
+    this.connection.onRequest(
+      "exitPlanMode.request",
+      async (params) => await this.handleExitPlanModeRequest(params)
+    );
+    this.connection.onRequest(
+      "autoModeSwitch.request",
+      async (params) => await this.handleAutoModeSwitchRequest(params)
+    );
     this.connection.onRequest(
       "hooks.invoke",
       async (params) => await this.handleHooksInvoke(params)
@@ -1375,6 +1410,35 @@ stderr: ${stderrOutput}`
     });
     return result;
   }
+  async handleExitPlanModeRequest(params) {
+    if (!params || typeof params.sessionId !== "string" || typeof params.summary !== "string" || !Array.isArray(params.actions) || typeof params.recommendedAction !== "string") {
+      throw new Error("Invalid exit plan mode request payload");
+    }
+    const session = this.sessions.get(params.sessionId);
+    if (!session) {
+      throw new Error(`Session not found: ${params.sessionId}`);
+    }
+    return await session._handleExitPlanModeRequest({
+      summary: params.summary,
+      planContent: params.planContent,
+      actions: params.actions,
+      recommendedAction: params.recommendedAction
+    });
+  }
+  async handleAutoModeSwitchRequest(params) {
+    if (!params || typeof params.sessionId !== "string") {
+      throw new Error("Invalid auto mode switch request payload");
+    }
+    const session = this.sessions.get(params.sessionId);
+    if (!session) {
+      throw new Error(`Session not found: ${params.sessionId}`);
+    }
+    const response = await session._handleAutoModeSwitchRequest({
+      errorCode: params.errorCode,
+      retryAfterSeconds: params.retryAfterSeconds
+    });
+    return { response };
+  }
   async handleHooksInvoke(params) {
     if (!params || typeof params.sessionId !== "string" || typeof params.hookType !== "string") {
       throw new Error("Invalid hooks invoke payload");

package/dist/generated/rpc.d.ts

@@ -1338,6 +1338,17 @@ export interface PluginList {
      */
     plugins: Plugin[];
 }
+/** @experimental */
+export interface RemoteEnableResult {
+    /**
+     * Mission Control frontend URL for this session
+     */
+    url?: string;
+    /**
+     * Whether remote steering is enabled
+     */
+    remoteSteerable: boolean;
+}
 export interface ServerSkill {
     /**
      * Unique identifier for the skill
@@ -2436,6 +2447,11 @@ export declare function createSessionRpc(connection: MessageConnection, sessionI
     usage: {
         getMetrics: () => Promise<UsageGetMetricsResult>;
     };
+    /** @experimental */
+    remote: {
+        enable: () => Promise<RemoteEnableResult>;
+        disable: () => Promise<void>;
+    };
 };
 /** Handler for `sessionFs` client session API methods. */
 export interface SessionFsHandler {

package/dist/generated/rpc.js

@@ -150,6 +150,11 @@ function createSessionRpc(connection, sessionId) {
     /** @experimental */
     usage: {
       getMetrics: async () => connection.sendRequest("session.usage.getMetrics", { sessionId })
+    },
+    /** @experimental */
+    remote: {
+      enable: async () => connection.sendRequest("session.remote.enable", { sessionId }),
+      disable: async () => connection.sendRequest("session.remote.disable", { sessionId })
     }
   };
 }

package/dist/generated/session-events.d.ts

@@ -2,7 +2,7 @@
  * AUTO-GENERATED FILE - DO NOT EDIT
  * Generated from: session-events.schema.json
  */
-export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | PlanChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | ExtensionsLoadedEvent;
+export type SessionEvent = StartEvent | ResumeEvent | RemoteSteerableChangedEvent | ErrorEvent | IdleEvent | TitleChangedEvent | ScheduleCreatedEvent | ScheduleCancelledEvent | InfoEvent | WarningEvent | ModelChangeEvent | ModeChangedEvent | PlanChangedEvent | WorkspaceFileChangedEvent | HandoffEvent | TruncationEvent | SnapshotRewindEvent | ShutdownEvent | ContextChangedEvent | UsageInfoEvent | CompactionStartEvent | CompactionCompleteEvent | TaskCompleteEvent | UserMessageEvent | PendingMessagesModifiedEvent | AssistantTurnStartEvent | AssistantIntentEvent | AssistantReasoningEvent | AssistantReasoningDeltaEvent | AssistantStreamingDeltaEvent | AssistantMessageEvent | AssistantMessageStartEvent | AssistantMessageDeltaEvent | AssistantTurnEndEvent | AssistantUsageEvent | ModelCallFailureEvent | AbortEvent | ToolUserRequestedEvent | ToolExecutionStartEvent | ToolExecutionPartialResultEvent | ToolExecutionProgressEvent | ToolExecutionCompleteEvent | SkillInvokedEvent | SubagentStartedEvent | SubagentCompletedEvent | SubagentFailedEvent | SubagentSelectedEvent | SubagentDeselectedEvent | HookStartEvent | HookEndEvent | SystemMessageEvent | SystemNotificationEvent | PermissionRequestedEvent | PermissionCompletedEvent | UserInputRequestedEvent | UserInputCompletedEvent | ElicitationRequestedEvent | ElicitationCompletedEvent | SamplingRequestedEvent | SamplingCompletedEvent | McpOauthRequiredEvent | McpOauthCompletedEvent | ExternalToolRequestedEvent | ExternalToolCompletedEvent | CommandQueuedEvent | CommandExecuteEvent | CommandCompletedEvent | AutoModeSwitchRequestedEvent | AutoModeSwitchCompletedEvent | CommandsChangedEvent | CapabilitiesChangedEvent | ExitPlanModeRequestedEvent | ExitPlanModeCompletedEvent | ToolsUpdatedEvent | BackgroundTasksChangedEvent | SkillsLoadedEvent | CustomAgentsUpdatedEvent | McpServersLoadedEvent | McpServerStatusChangedEvent | ExtensionsLoadedEvent;
 /**
  * Hosting platform type of the repository (github or ado)
  */
@@ -43,6 +43,10 @@ export type AssistantMessageToolRequestType = "function" | "custom";
  * Where the failed model call originated
  */
 export type ModelCallFailureSource = "top_level" | "subagent" | "mcp_sampling";
+/**
+ * Finite reason code describing why the current turn was aborted
+ */
+export type AbortReason = "user_initiated" | "remote_command" | "user_abort";
 /**
  * A content block within a tool result, which may be text, terminal output, image, audio, or a resource
  */
@@ -444,6 +448,80 @@ export interface TitleChangedData {
      */
     title: string;
 }
+export interface ScheduleCreatedEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: ScheduleCreatedData;
+    /**
+     * When true, the event is transient and not persisted to the session event log on disk
+     */
+    ephemeral?: boolean;
+    /**
+     * Unique event identifier (UUID v4), generated when the event is emitted
+     */
+    id: string;
+    /**
+     * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
+     */
+    parentId: string | null;
+    /**
+     * ISO 8601 timestamp when the event was created
+     */
+    timestamp: string;
+    type: "session.schedule_created";
+}
+/**
+ * Scheduled prompt registered via /every
+ */
+export interface ScheduleCreatedData {
+    /**
+     * Sequential id assigned to the scheduled prompt within the session
+     */
+    id: number;
+    /**
+     * Interval between ticks in milliseconds
+     */
+    intervalMs: number;
+    /**
+     * Prompt text that gets enqueued on every tick
+     */
+    prompt: string;
+}
+export interface ScheduleCancelledEvent {
+    /**
+     * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
+     */
+    agentId?: string;
+    data: ScheduleCancelledData;
+    /**
+     * When true, the event is transient and not persisted to the session event log on disk
+     */
+    ephemeral?: boolean;
+    /**
+     * Unique event identifier (UUID v4), generated when the event is emitted
+     */
+    id: string;
+    /**
+     * ID of the chronologically preceding event in the session, forming a linked chain. Null for the first event.
+     */
+    parentId: string | null;
+    /**
+     * ISO 8601 timestamp when the event was created
+     */
+    timestamp: string;
+    type: "session.schedule_cancelled";
+}
+/**
+ * Scheduled prompt cancelled from the schedule manager dialog
+ */
+export interface ScheduleCancelledData {
+    /**
+     * Id of the scheduled prompt that was cancelled
+     */
+    id: number;
+}
 export interface InfoEvent {
     /**
      * Sub-agent instance identifier. Absent for events from the root/main agent and session-level events.
@@ -1812,6 +1890,10 @@ export interface AssistantMessageToolRequest {
      * Name of the MCP server hosting this tool, when the tool is an MCP tool
      */
     mcpServerName?: string;
+    /**
+     * Original tool name on the MCP server, when the tool is an MCP tool
+     */
+    mcpToolName?: string;
     /**
      * Name of the tool being invoked
      */
@@ -2177,10 +2259,7 @@ export interface AbortEvent {
  * Turn abort information including the reason for termination
  */
 export interface AbortData {
-    /**
-     * Reason the current turn was aborted (e.g., "user initiated")
-     */
-    reason: string;
+    reason: AbortReason;
 }
 export interface ToolUserRequestedEvent {
     /**
@@ -2707,6 +2786,10 @@ export interface SubagentStartedData {
      * Internal name of the sub-agent
      */
     agentName: string;
+    /**
+     * Model the sub-agent will run with, when known at start. Surfaced in the timeline for auto-selected sub-agents (e.g. rubber-duck).
+     */
+    model?: string;
     /**
      * Tool call ID of the parent tool invocation that spawned this sub-agent
      */
@@ -4849,9 +4932,9 @@ export interface CustomAgentsUpdatedAgent {
      */
     source: string;
     /**
-     * List of tool names available to this agent
+     * List of tool names available to this agent, or null when all tools are available
      */
-    tools: string[];
+    tools: string[] | null;
     /**
      * Whether the agent can be selected by the user
      */

package/dist/index.d.ts

@@ -6,4 +6,4 @@
 export { CopilotClient } from "./client.js";
 export { CopilotSession, type AssistantMessageEvent } from "./session.js";
 export { defineTool, approveAll, convertMcpCallToolResult, createSessionFsAdapter, SYSTEM_PROMPT_SECTIONS, } from "./types.js";
-export type { CommandContext, CommandDefinition, CommandHandler, ConnectionState, CopilotClientOptions, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, InputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, MessageOptions, ModelBilling, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventType, SessionLifecycleHandler, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemPromptSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";
+export type { CommandContext, CommandDefinition, CommandHandler, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, ConnectionState, CopilotClientOptions, CustomAgentConfig, ElicitationFieldValue, ElicitationHandler, ElicitationParams, ElicitationContext, ElicitationResult, ElicitationSchema, ElicitationSchemaField, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, ForegroundSessionInfo, GetAuthStatusResponse, GetStatusResponse, InfiniteSessionConfig, InputOptions, MCPStdioServerConfig, MCPHTTPServerConfig, MCPServerConfig, DefaultAgentConfig, MessageOptions, ModelBilling, ModelCapabilities, ModelCapabilitiesOverride, ModelInfo, ModelPolicy, PermissionHandler, PermissionRequest, PermissionRequestResult, ProviderConfig, ResumeSessionConfig, SectionOverride, SectionOverrideAction, SectionTransformFn, SessionCapabilities, SessionConfig, SessionEvent, SessionEventHandler, SessionEventPayload, SessionEventType, SessionLifecycleEvent, SessionLifecycleEventType, SessionLifecycleHandler, SessionContext, SessionListFilter, SessionMetadata, SessionUiApi, SessionFsConfig, SessionFsProvider, SessionFsFileInfo, SystemMessageAppendConfig, SystemMessageConfig, SystemMessageCustomizeConfig, SystemMessageReplaceConfig, SystemPromptSection, TelemetryConfig, TraceContext, TraceContextProvider, Tool, ToolHandler, ToolInvocation, ToolResultObject, TypedSessionEventHandler, TypedSessionLifecycleHandler, ZodSchema, } from "./types.js";

package/dist/session.d.ts

@@ -5,7 +5,7 @@
 import type { MessageConnection } from "vscode-jsonrpc/node.js";
 import { createSessionRpc } from "./generated/rpc.js";
 import type { ClientSessionApiHandlers } from "./generated/rpc.js";
-import type { CommandHandler, ElicitationHandler, ElicitationContext, MessageOptions, PermissionHandler, PermissionRequestResult, ReasoningEffort, ModelCapabilitiesOverride, SectionTransformFn, SessionCapabilities, SessionEvent, SessionEventHandler, SessionEventType, SessionHooks, SessionUiApi, Tool, ToolHandler, TraceContextProvider, TypedSessionEventHandler, UserInputHandler, UserInputResponse } from "./types.js";
+import type { CommandHandler, AutoModeSwitchHandler, AutoModeSwitchRequest, AutoModeSwitchResponse, ElicitationHandler, ElicitationContext, ExitPlanModeHandler, ExitPlanModeRequest, ExitPlanModeResult, MessageOptions, PermissionHandler, PermissionRequestResult, ReasoningEffort, ModelCapabilitiesOverride, SectionTransformFn, SessionCapabilities, SessionEvent, SessionEventHandler, SessionEventType, SessionHooks, SessionUiApi, Tool, ToolHandler, TraceContextProvider, TypedSessionEventHandler, UserInputHandler, UserInputResponse } from "./types.js";
 export declare const NO_RESULT_PERMISSION_V2_ERROR = "Permission handlers cannot return 'no-result' when connected to a protocol v2 server.";
 /** Assistant message event - the final response from the assistant. */
 export type AssistantMessageEvent = Extract<SessionEvent, {
@@ -47,6 +47,8 @@ export declare class CopilotSession {
     private permissionHandler?;
     private userInputHandler?;
     private elicitationHandler?;
+    private exitPlanModeHandler?;
+    private autoModeSwitchHandler?;
     private hooks?;
     private transformCallbacks?;
     private _rpc;
@@ -246,12 +248,36 @@ export declare class CopilotSession {
      * @internal This method is typically called internally when creating/resuming a session.
      */
     registerElicitationHandler(handler?: ElicitationHandler): void;
+    /**
+     * Registers the exit-plan-mode handler for this session.
+     *
+     * @param handler - The handler to invoke when the server dispatches an exit-plan-mode request
+     * @internal This method is typically called internally when creating/resuming a session.
+     */
+    registerExitPlanModeHandler(handler?: ExitPlanModeHandler): void;
+    /**
+     * Registers the auto-mode-switch handler for this session.
+     *
+     * @param handler - The handler to invoke when the server dispatches an auto-mode-switch request
+     * @internal This method is typically called internally when creating/resuming a session.
+     */
+    registerAutoModeSwitchHandler(handler?: AutoModeSwitchHandler): void;
     /**
      * Handles an elicitation.requested broadcast event.
      * Invokes the registered handler and responds via handlePendingElicitation RPC.
      * @internal
      */
     _handleElicitationRequest(context: ElicitationContext, requestId: string): Promise<void>;
+    /**
+     * Handles an exitPlanMode.request callback from the runtime.
+     * @internal
+     */
+    _handleExitPlanModeRequest(request: ExitPlanModeRequest): Promise<ExitPlanModeResult>;
+    /**
+     * Handles an autoModeSwitch.request callback from the runtime.
+     * @internal
+     */
+    _handleAutoModeSwitchRequest(request: AutoModeSwitchRequest): Promise<AutoModeSwitchResponse>;
     /**
      * Sets the host capabilities for this session.
      *

package/dist/session.js

@@ -25,6 +25,8 @@ class CopilotSession {
   permissionHandler;
   userInputHandler;
   elicitationHandler;
+  exitPlanModeHandler;
+  autoModeSwitchHandler;
   hooks;
   transformCallbacks;
   _rpc = null;
@@ -420,6 +422,24 @@ class CopilotSession {
   registerElicitationHandler(handler) {
     this.elicitationHandler = handler;
   }
+  /**
+   * Registers the exit-plan-mode handler for this session.
+   *
+   * @param handler - The handler to invoke when the server dispatches an exit-plan-mode request
+   * @internal This method is typically called internally when creating/resuming a session.
+   */
+  registerExitPlanModeHandler(handler) {
+    this.exitPlanModeHandler = handler;
+  }
+  /**
+   * Registers the auto-mode-switch handler for this session.
+   *
+   * @param handler - The handler to invoke when the server dispatches an auto-mode-switch request
+   * @internal This method is typically called internally when creating/resuming a session.
+   */
+  registerAutoModeSwitchHandler(handler) {
+    this.autoModeSwitchHandler = handler;
+  }
   /**
    * Handles an elicitation.requested broadcast event.
    * Invokes the registered handler and responds via handlePendingElicitation RPC.
@@ -445,6 +465,26 @@ class CopilotSession {
       }
     }
   }
+  /**
+   * Handles an exitPlanMode.request callback from the runtime.
+   * @internal
+   */
+  async _handleExitPlanModeRequest(request) {
+    if (!this.exitPlanModeHandler) {
+      return { approved: true };
+    }
+    return await this.exitPlanModeHandler(request, { sessionId: this.sessionId });
+  }
+  /**
+   * Handles an autoModeSwitch.request callback from the runtime.
+   * @internal
+   */
+  async _handleAutoModeSwitchRequest(request) {
+    if (!this.autoModeSwitchHandler) {
+      return "no";
+    }
+    return await this.autoModeSwitchHandler(request, { sessionId: this.sessionId });
+  }
   /**
    * Sets the host capabilities for this session.
    *
@@ -725,6 +765,10 @@ class CopilotSession {
     this.typedEventHandlers.clear();
     this.toolHandlers.clear();
     this.permissionHandler = void 0;
+    this.userInputHandler = void 0;
+    this.elicitationHandler = void 0;
+    this.exitPlanModeHandler = void 0;
+    this.autoModeSwitchHandler = void 0;
   }
   /**
    * @deprecated Use {@link disconnect} instead. This method will be removed in a future release.

package/dist/sessionFsProvider.d.ts

@@ -6,7 +6,7 @@ import type { SessionFsHandler, SessionFsStatResult, SessionFsReaddirWithTypesEn
  */
 export type SessionFsFileInfo = Omit<SessionFsStatResult, "error">;
 /**
- * Interface for session filesystem providers. Implementors use idiomatic
+ * Interface for session filesystem providers. Implementers use idiomatic
  * TypeScript patterns: throw on error, return values directly. Use
  * {@link createSessionFsAdapter} to convert a provider into the
  * {@link SessionFsHandler} expected by the SDK.

package/dist/types.d.ts

@@ -182,6 +182,15 @@ export interface CopilotClientOptions {
      * `useStdio: true` (stdio is pre-authenticated by transport).
      */
     tcpConnectionToken?: string;
+    /**
+     * Enable remote session support (Mission Control integration).
+     * When true, sessions in a GitHub repository working directory are
+     * accessible from GitHub web and mobile.
+     * This option is only used when the SDK spawns the CLI process; it is ignored
+     * when connecting to an external server via {@link cliUrl}.
+     * @default false
+     */
+    remote?: boolean;
 }
 /**
  * Configuration for creating a session
@@ -641,6 +650,55 @@ export interface UserInputResponse {
 export type UserInputHandler = (request: UserInputRequest, invocation: {
     sessionId: string;
 }) => Promise<UserInputResponse> | UserInputResponse;
+/**
+ * Request to exit plan mode and continue with a selected action.
+ */
+export interface ExitPlanModeRequest {
+    /** Summary of the plan or proposed next step. */
+    summary: string;
+    /** Full plan content, when available. */
+    planContent?: string;
+    /** Available actions the user can select. */
+    actions: string[];
+    /** The action recommended by the runtime. */
+    recommendedAction: string;
+}
+/**
+ * Response to an exit-plan-mode request.
+ */
+export interface ExitPlanModeResult {
+    /** Whether the user approved exiting plan mode. */
+    approved: boolean;
+    /** Selected action, if the user chose one. */
+    selectedAction?: string;
+    /** Optional feedback provided by the user. */
+    feedback?: string;
+}
+/**
+ * Handler for exit-plan-mode requests from the agent.
+ */
+export type ExitPlanModeHandler = (request: ExitPlanModeRequest, invocation: {
+    sessionId: string;
+}) => Promise<ExitPlanModeResult> | ExitPlanModeResult;
+/**
+ * Request to switch to auto mode after an eligible rate limit.
+ */
+export interface AutoModeSwitchRequest {
+    /** The rate-limit error code that triggered the request. */
+    errorCode?: string;
+    /** Seconds until the rate limit resets, when known. */
+    retryAfterSeconds?: number;
+}
+/**
+ * Response to an auto-mode-switch request.
+ */
+export type AutoModeSwitchResponse = "yes" | "yes_always" | "no";
+/**
+ * Handler for auto-mode-switch requests from the agent.
+ */
+export type AutoModeSwitchHandler = (request: AutoModeSwitchRequest, invocation: {
+    sessionId: string;
+}) => Promise<AutoModeSwitchResponse> | AutoModeSwitchResponse;
 /**
  * Base interface for all hook inputs
  */
@@ -1011,6 +1069,15 @@ export interface SessionConfig {
      * When specified, uses the provided API endpoint instead of the Copilot API.
      */
     provider?: ProviderConfig;
+    /**
+     * Enables or disables internal session telemetry for this session.
+     * When `false`, disables session telemetry. When omitted (the default) or `true`,
+     * telemetry is enabled for GitHub-authenticated sessions.
+     * When a custom {@link provider} (BYOK) is configured, session telemetry is always
+     * disabled regardless of this setting.
+     * This is independent of the OpenTelemetry configuration in {@link CopilotClientOptions.telemetry}.
+     */
+    enableSessionTelemetry?: boolean;
     /**
      * Handler for permission requests from the server.
      * When provided, the server will call this handler to request permission for operations.
@@ -1027,6 +1094,16 @@ export interface SessionConfig {
      * Also enables the `elicitation` capability on the session.
      */
     onElicitationRequest?: ElicitationHandler;
+    /**
+     * Handler for exit-plan-mode requests from the agent.
+     * When provided, enables `exitPlanMode.request` callbacks.
+     */
+    onExitPlanMode?: ExitPlanModeHandler;
+    /**
+     * Handler for auto-mode-switch requests from the agent.
+     * When provided, enables `autoModeSwitch.request` callbacks.
+     */
+    onAutoModeSwitch?: AutoModeSwitchHandler;
     /**
      * Hook handlers for intercepting session lifecycle events.
      * When provided, enables hooks callback allowing custom logic at various points.
@@ -1118,7 +1195,7 @@ export interface SessionConfig {
 /**
  * Configuration for resuming a session
  */
-export type ResumeSessionConfig = Pick<SessionConfig, "clientName" | "model" | "tools" | "commands" | "systemMessage" | "availableTools" | "excludedTools" | "provider" | "modelCapabilities" | "streaming" | "includeSubAgentStreamingEvents" | "reasoningEffort" | "onPermissionRequest" | "onUserInputRequest" | "onElicitationRequest" | "hooks" | "workingDirectory" | "configDir" | "enableConfigDiscovery" | "mcpServers" | "customAgents" | "defaultAgent" | "agent" | "skillDirectories" | "instructionDirectories" | "disabledSkills" | "infiniteSessions" | "gitHubToken" | "onEvent" | "createSessionFsHandler"> & {
+export type ResumeSessionConfig = Pick<SessionConfig, "clientName" | "model" | "tools" | "commands" | "systemMessage" | "availableTools" | "excludedTools" | "provider" | "enableSessionTelemetry" | "modelCapabilities" | "streaming" | "includeSubAgentStreamingEvents" | "reasoningEffort" | "onPermissionRequest" | "onUserInputRequest" | "onElicitationRequest" | "onExitPlanMode" | "onAutoModeSwitch" | "hooks" | "workingDirectory" | "configDir" | "enableConfigDiscovery" | "mcpServers" | "customAgents" | "defaultAgent" | "agent" | "skillDirectories" | "instructionDirectories" | "disabledSkills" | "infiniteSessions" | "gitHubToken" | "onEvent" | "createSessionFsHandler"> & {
     /**
      * When true, skips emitting the session.resume event.
      * Useful for reconnecting to a session without triggering resume-related side effects.
@@ -1177,6 +1254,32 @@ export interface ProviderConfig {
      * Custom HTTP headers to include in outbound provider requests.
      */
     headers?: Record<string, string>;
+    /**
+     * Well-known model name used by the runtime to look up agent configuration
+     * (tools, prompts, reasoning behavior) and default token limits. Also used
+     * as the wire model when {@link wireModel} is not set.
+     * Falls back to {@link SessionConfig.model}.
+     */
+    modelId?: string;
+    /**
+     * Model name sent to the provider API for inference. Use this when the
+     * provider's model name (e.g. an Azure deployment name or a custom
+     * fine-tune name) differs from {@link modelId}.
+     * Falls back to {@link modelId}, then {@link SessionConfig.model}.
+     */
+    wireModel?: string;
+    /**
+     * Overrides the resolved model's default max prompt tokens. The runtime
+     * triggers conversation compaction before sending a request when the
+     * prompt (system message, history, tool definitions, user message) would
+     * exceed this limit.
+     */
+    maxInputTokens?: number;
+    /**
+     * Overrides the resolved model's default max output tokens. When hit, the
+     * model stops generating and returns a truncated response.
+     */
+    maxOutputTokens?: number;
 }
 /**
  * Options for sending a message to a session

package/dist/types.js

@@ -23,9 +23,10 @@ function convertMcpCallToolResult(callResult) {
           textParts.push(block.resource.text);
         }
         if (block.resource?.blob) {
+          const mimeType = block.resource.mimeType;
           binaryResults.push({
             data: block.resource.blob,
-            mimeType: block.resource.mimeType ?? "application/octet-stream",
+            mimeType: typeof mimeType === "string" && mimeType ? mimeType : "application/octet-stream",
             type: "resource",
             description: block.resource.uri
           });

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "https://github.com/github/copilot-sdk.git"
   },
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.3",
   "description": "TypeScript SDK for programmatic control of GitHub Copilot CLI via JSON-RPC",
   "main": "./dist/cjs/index.js",
   "types": "./dist/index.d.ts",
@@ -56,7 +56,7 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@github/copilot": "^1.0.41-0",
+    "@github/copilot": "^1.0.44-2",
     "vscode-jsonrpc": "^8.2.1",
     "zod": "^4.3.6"
   },