handlePendin
return caller.invoke("session.commands.handlePendingCommand", _p, SessionCommandsHandlePendingCommandResult.class);
}
+ /**
+ * Invokes {@code session.commands.respondToQueuedCommand}.
+ *
+ * Note: the {@code sessionId} field in the params record is overridden
+ * by the session-scoped wrapper; any value provided is ignored.
+ * @since 1.0.0
+ */
+ public CompletableFuture respondToQueuedCommand(SessionCommandsRespondToQueuedCommandParams params) {
+ com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params);
+ _p.put("sessionId", this.sessionId);
+ return caller.invoke("session.commands.respondToQueuedCommand", _p, SessionCommandsRespondToQueuedCommandResult.class);
+ }
+
}
diff --git a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java
new file mode 100644
index 0000000000..46796b728c
--- /dev/null
+++ b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionCommandsRespondToQueuedCommandParams.java
@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+// AUTO-GENERATED FILE - DO NOT EDIT
+// Generated from: api.schema.json
+
+package com.github.copilot.sdk.generated.rpc;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import javax.annotation.processing.Generated;
+
+/**
+ * Request parameters for the {@code session.commands.respondToQueuedCommand} RPC method.
+ *
+ * @since 1.0.0
+ */
+@javax.annotation.processing.Generated("copilot-sdk-codegen")
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public record SessionCommandsRespondToQueuedCommandParams(
+ /** Target session identifier */
+ @JsonProperty("sessionId") String sessionId,
+ /** Request ID from the queued command event */
+ @JsonProperty("requestId") String requestId,
+ /** Result of the queued command execution */
+ @JsonProperty("result") Object result
+) {
+}
diff --git a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java
new file mode 100644
index 0000000000..272849411a
--- /dev/null
+++ b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionCommandsRespondToQueuedCommandResult.java
@@ -0,0 +1,27 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+// AUTO-GENERATED FILE - DO NOT EDIT
+// Generated from: api.schema.json
+
+package com.github.copilot.sdk.generated.rpc;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import javax.annotation.processing.Generated;
+
+/**
+ * Result for the {@code session.commands.respondToQueuedCommand} RPC method.
+ *
+ * @since 1.0.0
+ */
+@javax.annotation.processing.Generated("copilot-sdk-codegen")
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public record SessionCommandsRespondToQueuedCommandResult(
+ /** Whether the response was accepted (false if the requestId was not found or already resolved) */
+ @JsonProperty("success") Boolean success
+) {
+}
diff --git a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksApi.java b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksApi.java
index 8e5f0ddeb3..6ee8ed2052 100644
--- a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksApi.java
+++ b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksApi.java
@@ -99,4 +99,19 @@ public CompletableFuture remove(SessionTasksRemovePara
return caller.invoke("session.tasks.remove", _p, SessionTasksRemoveResult.class);
}
+ /**
+ * Invokes {@code session.tasks.sendMessage}.
+ *
+ * Note: the {@code sessionId} field in the params record is overridden
+ * by the session-scoped wrapper; any value provided is ignored.
+ *
+ * @apiNote This method is experimental and may change in a future version.
+ * @since 1.0.0
+ */
+ public CompletableFuture sendMessage(SessionTasksSendMessageParams params) {
+ com.fasterxml.jackson.databind.node.ObjectNode _p = MAPPER.valueToTree(params);
+ _p.put("sessionId", this.sessionId);
+ return caller.invoke("session.tasks.sendMessage", _p, SessionTasksSendMessageResult.class);
+ }
+
}
diff --git a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksSendMessageParams.java b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksSendMessageParams.java
new file mode 100644
index 0000000000..70c70eed75
--- /dev/null
+++ b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksSendMessageParams.java
@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+// AUTO-GENERATED FILE - DO NOT EDIT
+// Generated from: api.schema.json
+
+package com.github.copilot.sdk.generated.rpc;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import javax.annotation.processing.Generated;
+
+/**
+ * Request parameters for the {@code session.tasks.sendMessage} RPC method.
+ *
+ * @since 1.0.0
+ */
+@javax.annotation.processing.Generated("copilot-sdk-codegen")
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public record SessionTasksSendMessageParams(
+ /** Target session identifier */
+ @JsonProperty("sessionId") String sessionId,
+ /** Agent task identifier */
+ @JsonProperty("id") String id,
+ /** Message content to send to the agent */
+ @JsonProperty("message") String message,
+ /** Agent ID of the sender, if sent on behalf of another agent */
+ @JsonProperty("fromAgentId") String fromAgentId
+) {
+}
diff --git a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksSendMessageResult.java b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksSendMessageResult.java
new file mode 100644
index 0000000000..f4aabb1710
--- /dev/null
+++ b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionTasksSendMessageResult.java
@@ -0,0 +1,29 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+// AUTO-GENERATED FILE - DO NOT EDIT
+// Generated from: api.schema.json
+
+package com.github.copilot.sdk.generated.rpc;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import javax.annotation.processing.Generated;
+
+/**
+ * Result for the {@code session.tasks.sendMessage} RPC method.
+ *
+ * @since 1.0.0
+ */
+@javax.annotation.processing.Generated("copilot-sdk-codegen")
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public record SessionTasksSendMessageResult(
+ /** Whether the message was successfully delivered or steered */
+ @JsonProperty("sent") Boolean sent,
+ /** Error message if delivery failed */
+ @JsonProperty("error") String error
+) {
+}
diff --git a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionWorkspacesGetWorkspaceResult.java b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionWorkspacesGetWorkspaceResult.java
index c2afa210bd..6474c29822 100644
--- a/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionWorkspacesGetWorkspaceResult.java
+++ b/src/generated/java/com/github/copilot/sdk/generated/rpc/SessionWorkspacesGetWorkspaceResult.java
@@ -38,7 +38,6 @@ public record SessionWorkspacesGetWorkspaceResultWorkspace(
@JsonProperty("branch") String branch,
@JsonProperty("name") String name,
@JsonProperty("user_named") Boolean userNamed,
- @JsonProperty("summary") String summary,
@JsonProperty("summary_count") Long summaryCount,
@JsonProperty("created_at") OffsetDateTime createdAt,
@JsonProperty("updated_at") OffsetDateTime updatedAt,
@@ -46,7 +45,6 @@ public record SessionWorkspacesGetWorkspaceResultWorkspace(
@JsonProperty("mc_task_id") String mcTaskId,
@JsonProperty("mc_session_id") String mcSessionId,
@JsonProperty("mc_last_event_id") String mcLastEventId,
- @JsonProperty("session_sync_level") SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel sessionSyncLevel,
@JsonProperty("chronicle_sync_dismissed") Boolean chronicleSyncDismissed
) {
@@ -68,26 +66,5 @@ public static SessionWorkspacesGetWorkspaceResultWorkspaceHostType fromValue(Str
throw new IllegalArgumentException("Unknown SessionWorkspacesGetWorkspaceResultWorkspaceHostType value: " + value);
}
}
-
- public enum SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel {
- /** The {@code local} variant. */
- LOCAL("local"),
- /** The {@code user} variant. */
- USER("user"),
- /** The {@code repo_and_user} variant. */
- REPO_AND_USER("repo_and_user");
-
- private final String value;
- SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel(String value) { this.value = value; }
- @com.fasterxml.jackson.annotation.JsonValue
- public String getValue() { return value; }
- @com.fasterxml.jackson.annotation.JsonCreator
- public static SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel fromValue(String value) {
- for (SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel v : values()) {
- if (v.value.equals(value)) return v;
- }
- throw new IllegalArgumentException("Unknown SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel value: " + value);
- }
- }
}
}
diff --git a/src/main/java/com/github/copilot/sdk/CopilotSession.java b/src/main/java/com/github/copilot/sdk/CopilotSession.java
index e4cb984644..ad5561c09e 100644
--- a/src/main/java/com/github/copilot/sdk/CopilotSession.java
+++ b/src/main/java/com/github/copilot/sdk/CopilotSession.java
@@ -54,6 +54,10 @@
import com.github.copilot.sdk.generated.SessionEvent;
import com.github.copilot.sdk.generated.SessionIdleEvent;
import com.github.copilot.sdk.json.AgentInfo;
+import com.github.copilot.sdk.json.AutoModeSwitchHandler;
+import com.github.copilot.sdk.json.AutoModeSwitchInvocation;
+import com.github.copilot.sdk.json.AutoModeSwitchRequest;
+import com.github.copilot.sdk.json.AutoModeSwitchResponse;
import com.github.copilot.sdk.json.CommandContext;
import com.github.copilot.sdk.json.CommandDefinition;
import com.github.copilot.sdk.json.CommandHandler;
@@ -62,6 +66,10 @@
import com.github.copilot.sdk.json.ElicitationParams;
import com.github.copilot.sdk.json.ElicitationResult;
import com.github.copilot.sdk.json.ElicitationResultAction;
+import com.github.copilot.sdk.json.ExitPlanModeHandler;
+import com.github.copilot.sdk.json.ExitPlanModeInvocation;
+import com.github.copilot.sdk.json.ExitPlanModeRequest;
+import com.github.copilot.sdk.json.ExitPlanModeResult;
import com.github.copilot.sdk.json.ElicitationSchema;
import com.github.copilot.sdk.json.GetMessagesResponse;
import com.github.copilot.sdk.json.HookInvocation;
@@ -156,6 +164,8 @@ public final class CopilotSession implements AutoCloseable {
private final AtomicReference permissionHandler = new AtomicReference<>();
private final AtomicReference userInputHandler = new AtomicReference<>();
private final AtomicReference elicitationHandler = new AtomicReference<>();
+ private final AtomicReference exitPlanModeHandler = new AtomicReference<>();
+ private final AtomicReference autoModeSwitchHandler = new AtomicReference<>();
private final AtomicReference hooksHandler = new AtomicReference<>();
private volatile EventErrorHandler eventErrorHandler;
private volatile EventErrorPolicy eventErrorPolicy = EventErrorPolicy.PROPAGATE_AND_LOG_ERRORS;
@@ -1317,6 +1327,32 @@ void registerElicitationHandler(ElicitationHandler handler) {
elicitationHandler.set(handler);
}
+ /**
+ * Registers an exit-plan-mode handler for this session.
+ *
+ * Called internally when creating or resuming a session with an exit-plan-mode
+ * handler.
+ *
+ * @param handler
+ * the handler to invoke when an exit-plan-mode request is received
+ */
+ void registerExitPlanModeHandler(ExitPlanModeHandler handler) {
+ exitPlanModeHandler.set(handler);
+ }
+
+ /**
+ * Registers an auto-mode-switch handler for this session.
+ *
+ * Called internally when creating or resuming a session with an
+ * auto-mode-switch handler.
+ *
+ * @param handler
+ * the handler to invoke when an auto-mode-switch request is received
+ */
+ void registerAutoModeSwitchHandler(AutoModeSwitchHandler handler) {
+ autoModeSwitchHandler.set(handler);
+ }
+
/**
* Sets the capabilities reported by the host for this session.
*
@@ -1356,6 +1392,60 @@ CompletableFuture handleUserInputRequest(UserInputRequest req
}
}
+ /**
+ * Handles an exit-plan-mode request from the Copilot CLI.
+ *
+ * Called internally when the server sends an {@code exitPlanMode.request}.
+ *
+ * @param request
+ * the exit-plan-mode request
+ * @return a future that resolves with the user's decision
+ */
+ CompletableFuture handleExitPlanModeRequest(ExitPlanModeRequest request) {
+ ExitPlanModeHandler handler = exitPlanModeHandler.get();
+ if (handler == null) {
+ return CompletableFuture.completedFuture(new ExitPlanModeResult().setApproved(true));
+ }
+
+ try {
+ var invocation = new ExitPlanModeInvocation().setSessionId(sessionId);
+ return handler.handle(request, invocation).exceptionally(ex -> {
+ LOG.log(Level.SEVERE, "Exit plan mode handler threw an exception", ex);
+ throw new RuntimeException("Exit plan mode handler error", ex);
+ });
+ } catch (Exception e) {
+ LOG.log(Level.SEVERE, "Failed to process exit plan mode request", e);
+ return CompletableFuture.failedFuture(e);
+ }
+ }
+
+ /**
+ * Handles an auto-mode-switch request from the Copilot CLI.
+ *
+ * Called internally when the server sends an {@code autoModeSwitch.request}.
+ *
+ * @param request
+ * the auto-mode-switch request
+ * @return a future that resolves with the user's decision
+ */
+ CompletableFuture handleAutoModeSwitchRequest(AutoModeSwitchRequest request) {
+ AutoModeSwitchHandler handler = autoModeSwitchHandler.get();
+ if (handler == null) {
+ return CompletableFuture.completedFuture(AutoModeSwitchResponse.NO);
+ }
+
+ try {
+ var invocation = new AutoModeSwitchInvocation().setSessionId(sessionId);
+ return handler.handle(request, invocation).exceptionally(ex -> {
+ LOG.log(Level.SEVERE, "Auto mode switch handler threw an exception", ex);
+ throw new RuntimeException("Auto mode switch handler error", ex);
+ });
+ } catch (Exception e) {
+ LOG.log(Level.SEVERE, "Failed to process auto mode switch request", e);
+ return CompletableFuture.failedFuture(e);
+ }
+ }
+
/**
* Registers hook handlers for this session.
*
@@ -1850,6 +1940,8 @@ public void close() {
permissionHandler.set(null);
userInputHandler.set(null);
elicitationHandler.set(null);
+ exitPlanModeHandler.set(null);
+ autoModeSwitchHandler.set(null);
hooksHandler.set(null);
}
diff --git a/src/main/java/com/github/copilot/sdk/RpcHandlerDispatcher.java b/src/main/java/com/github/copilot/sdk/RpcHandlerDispatcher.java
index d085f7fcec..1d76d8b88a 100644
--- a/src/main/java/com/github/copilot/sdk/RpcHandlerDispatcher.java
+++ b/src/main/java/com/github/copilot/sdk/RpcHandlerDispatcher.java
@@ -17,6 +17,8 @@
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.copilot.sdk.generated.SessionEvent;
+import com.github.copilot.sdk.json.AutoModeSwitchRequest;
+import com.github.copilot.sdk.json.ExitPlanModeRequest;
import com.github.copilot.sdk.json.PermissionRequestResult;
import com.github.copilot.sdk.json.PermissionRequestResultKind;
import com.github.copilot.sdk.json.SessionLifecycleEvent;
@@ -79,6 +81,10 @@ void registerHandlers(JsonRpcClient rpc) {
(requestId, params) -> handlePermissionRequest(rpc, requestId, params));
rpc.registerMethodHandler("userInput.request",
(requestId, params) -> handleUserInputRequest(rpc, requestId, params));
+ rpc.registerMethodHandler("exitPlanMode.request",
+ (requestId, params) -> handleExitPlanModeRequest(rpc, requestId, params));
+ rpc.registerMethodHandler("autoModeSwitch.request",
+ (requestId, params) -> handleAutoModeSwitchRequest(rpc, requestId, params));
rpc.registerMethodHandler("hooks.invoke", (requestId, params) -> handleHooksInvoke(rpc, requestId, params));
rpc.registerMethodHandler("systemMessage.transform",
(requestId, params) -> handleSystemMessageTransform(rpc, requestId, params));
@@ -125,6 +131,10 @@ private void handleLifecycleEvent(JsonNode params) {
private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params) {
runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "tool.call");
+ if (requestIdLong == -1) {
+ return;
+ }
try {
String sessionId = params.get("sessionId").asText();
String toolCallId = params.get("toolCallId").asText();
@@ -133,7 +143,7 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params
CopilotSession session = sessions.get(sessionId);
if (session == null) {
- rpc.sendErrorResponse(Long.parseLong(requestId), -32602, "Unknown session " + sessionId);
+ rpc.sendErrorResponse(requestIdLong, -32602, "Unknown session " + sessionId);
return;
}
@@ -141,7 +151,7 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params
if (tool == null || tool.handler() == null) {
var result = ToolResultObject.failure("Tool '" + toolName + "' is not supported.",
"tool '" + toolName + "' not supported");
- rpc.sendResponse(Long.parseLong(requestId), Map.of("result", result));
+ rpc.sendResponse(requestIdLong, Map.of("result", result));
return;
}
@@ -157,7 +167,7 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params
toolResult = ToolResultObject
.success(result instanceof String s ? s : MAPPER.writeValueAsString(result));
}
- rpc.sendResponse(Long.parseLong(requestId), Map.of("result", toolResult));
+ rpc.sendResponse(requestIdLong, Map.of("result", toolResult));
} catch (Exception e) {
LOG.log(Level.SEVERE, "Error sending tool result", e);
}
@@ -166,7 +176,7 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params
var result = ToolResultObject.failure(
"Invoking this tool produced an error. Detailed information is not available.",
ex.getMessage());
- rpc.sendResponse(Long.parseLong(requestId), Map.of("result", result));
+ rpc.sendResponse(requestIdLong, Map.of("result", result));
} catch (Exception e) {
LOG.log(Level.SEVERE, "Error sending tool error", e);
}
@@ -175,7 +185,7 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params
} catch (Exception e) {
LOG.log(Level.SEVERE, "Error handling tool call", e);
try {
- rpc.sendErrorResponse(Long.parseLong(requestId), -32603, e.getMessage());
+ rpc.sendErrorResponse(requestIdLong, -32603, e.getMessage());
} catch (IOException ioe) {
LOG.log(Level.SEVERE, "Failed to send error response", ioe);
}
@@ -185,6 +195,10 @@ private void handleToolCall(JsonRpcClient rpc, String requestId, JsonNode params
private void handlePermissionRequest(JsonRpcClient rpc, String requestId, JsonNode params) {
runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "permission.request");
+ if (requestIdLong == -1) {
+ return;
+ }
try {
String sessionId = params.get("sessionId").asText();
JsonNode permissionRequest = params.get("permissionRequest");
@@ -193,7 +207,7 @@ private void handlePermissionRequest(JsonRpcClient rpc, String requestId, JsonNo
if (session == null) {
var result = new PermissionRequestResult()
.setKind(PermissionRequestResultKind.DENIED_COULD_NOT_REQUEST_FROM_USER);
- rpc.sendResponse(Long.parseLong(requestId), Map.of("result", result));
+ rpc.sendResponse(requestIdLong, Map.of("result", result));
return;
}
@@ -206,7 +220,7 @@ private void handlePermissionRequest(JsonRpcClient rpc, String requestId, JsonNo
throw new IllegalStateException(
"Permission handlers cannot return 'no-result' when connected to a protocol v2 server.");
}
- rpc.sendResponse(Long.parseLong(requestId), Map.of("result", result));
+ rpc.sendResponse(requestIdLong, Map.of("result", result));
} catch (IOException e) {
LOG.log(Level.SEVERE, "Error sending permission result", e);
}
@@ -214,7 +228,7 @@ private void handlePermissionRequest(JsonRpcClient rpc, String requestId, JsonNo
try {
var result = new PermissionRequestResult()
.setKind(PermissionRequestResultKind.DENIED_COULD_NOT_REQUEST_FROM_USER);
- rpc.sendResponse(Long.parseLong(requestId), Map.of("result", result));
+ rpc.sendResponse(requestIdLong, Map.of("result", result));
} catch (IOException e) {
LOG.log(Level.SEVERE, "Error sending permission denied", e);
}
@@ -229,6 +243,10 @@ private void handlePermissionRequest(JsonRpcClient rpc, String requestId, JsonNo
private void handleUserInputRequest(JsonRpcClient rpc, String requestId, JsonNode params) {
LOG.fine("Received userInput.request: " + params);
runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "userInput.request");
+ if (requestIdLong == -1) {
+ return;
+ }
try {
String sessionId = params.get("sessionId").asText();
String question = params.get("question").asText();
@@ -240,7 +258,7 @@ private void handleUserInputRequest(JsonRpcClient rpc, String requestId, JsonNod
LOG.fine("Found session: " + (session != null));
if (session == null) {
LOG.fine("Session not found, sending error");
- rpc.sendErrorResponse(Long.parseLong(requestId), -32602, "Unknown session " + sessionId);
+ rpc.sendErrorResponse(requestIdLong, -32602, "Unknown session " + sessionId);
return;
}
@@ -262,7 +280,7 @@ private void handleUserInputRequest(JsonRpcClient rpc, String requestId, JsonNod
String answer = response.getAnswer() != null ? response.getAnswer() : "";
LOG.fine("Sending userInput response: answer=" + answer + ", wasFreeform="
+ response.isWasFreeform());
- rpc.sendResponse(Long.parseLong(requestId),
+ rpc.sendResponse(requestIdLong,
Map.of("answer", answer, "wasFreeform", response.isWasFreeform()));
} catch (IOException e) {
LOG.log(Level.SEVERE, "Error sending user input response", e);
@@ -270,8 +288,7 @@ private void handleUserInputRequest(JsonRpcClient rpc, String requestId, JsonNod
}).exceptionally(ex -> {
LOG.log(Level.WARNING, "User input handler exception", ex);
try {
- rpc.sendErrorResponse(Long.parseLong(requestId), -32603,
- "User input handler error: " + ex.getMessage());
+ rpc.sendErrorResponse(requestIdLong, -32603, "User input handler error: " + ex.getMessage());
} catch (IOException e) {
LOG.log(Level.SEVERE, "Error sending user input error", e);
}
@@ -283,8 +300,110 @@ private void handleUserInputRequest(JsonRpcClient rpc, String requestId, JsonNod
});
}
+ private void handleExitPlanModeRequest(JsonRpcClient rpc, String requestId, JsonNode params) {
+ runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "exitPlanMode.request");
+ if (requestIdLong == -1) {
+ return;
+ }
+ try {
+ String sessionId = params.get("sessionId").asText();
+
+ CopilotSession session = sessions.get(sessionId);
+ if (session == null) {
+ rpc.sendErrorResponse(requestIdLong, -32602, "Unknown session " + sessionId);
+ return;
+ }
+
+ var request = new ExitPlanModeRequest();
+ if (params.has("summary")) {
+ request.setSummary(params.get("summary").asText());
+ }
+ if (params.has("planContent") && !params.get("planContent").isNull()) {
+ request.setPlanContent(params.get("planContent").asText());
+ }
+ if (params.has("actions") && params.get("actions").isArray()) {
+ var actions = new ArrayList();
+ for (JsonNode action : params.get("actions")) {
+ actions.add(action.asText());
+ }
+ request.setActions(actions);
+ }
+ if (params.has("recommendedAction") && !params.get("recommendedAction").isNull()) {
+ request.setRecommendedAction(params.get("recommendedAction").asText());
+ }
+
+ session.handleExitPlanModeRequest(request).thenAccept(result -> {
+ try {
+ rpc.sendResponse(requestIdLong, MAPPER.valueToTree(result));
+ } catch (IOException e) {
+ LOG.log(Level.SEVERE, "Error sending exit plan mode response", e);
+ }
+ }).exceptionally(ex -> {
+ try {
+ rpc.sendErrorResponse(requestIdLong, -32603,
+ "Exit plan mode handler error: " + ex.getMessage());
+ } catch (IOException e) {
+ LOG.log(Level.SEVERE, "Error sending exit plan mode error", e);
+ }
+ return null;
+ });
+ } catch (Exception e) {
+ LOG.log(Level.SEVERE, "Error handling exit plan mode request", e);
+ }
+ });
+ }
+
+ private void handleAutoModeSwitchRequest(JsonRpcClient rpc, String requestId, JsonNode params) {
+ runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "autoModeSwitch.request");
+ if (requestIdLong == -1) {
+ return;
+ }
+ try {
+ String sessionId = params.get("sessionId").asText();
+
+ CopilotSession session = sessions.get(sessionId);
+ if (session == null) {
+ rpc.sendErrorResponse(requestIdLong, -32602, "Unknown session " + sessionId);
+ return;
+ }
+
+ var request = new AutoModeSwitchRequest();
+ if (params.has("errorCode") && !params.get("errorCode").isNull()) {
+ request.setErrorCode(params.get("errorCode").asText());
+ }
+ if (params.has("retryAfterSeconds") && !params.get("retryAfterSeconds").isNull()) {
+ request.setRetryAfterSeconds(params.get("retryAfterSeconds").asDouble());
+ }
+
+ session.handleAutoModeSwitchRequest(request).thenAccept(response -> {
+ try {
+ rpc.sendResponse(requestIdLong, Map.of("response", response));
+ } catch (IOException e) {
+ LOG.log(Level.SEVERE, "Error sending auto mode switch response", e);
+ }
+ }).exceptionally(ex -> {
+ try {
+ rpc.sendErrorResponse(requestIdLong, -32603,
+ "Auto mode switch handler error: " + ex.getMessage());
+ } catch (IOException e) {
+ LOG.log(Level.SEVERE, "Error sending auto mode switch error", e);
+ }
+ return null;
+ });
+ } catch (Exception e) {
+ LOG.log(Level.SEVERE, "Error handling auto mode switch request", e);
+ }
+ });
+ }
+
private void handleHooksInvoke(JsonRpcClient rpc, String requestId, JsonNode params) {
runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "hooks.invoke");
+ if (requestIdLong == -1) {
+ return;
+ }
try {
String sessionId = params.get("sessionId").asText();
String hookType = params.get("hookType").asText();
@@ -292,20 +411,19 @@ private void handleHooksInvoke(JsonRpcClient rpc, String requestId, JsonNode par
CopilotSession session = sessions.get(sessionId);
if (session == null) {
- rpc.sendErrorResponse(Long.parseLong(requestId), -32602, "Unknown session " + sessionId);
+ rpc.sendErrorResponse(requestIdLong, -32602, "Unknown session " + sessionId);
return;
}
session.handleHooksInvoke(hookType, input).thenAccept(output -> {
try {
- rpc.sendResponse(Long.parseLong(requestId), Collections.singletonMap("output", output));
+ rpc.sendResponse(requestIdLong, Collections.singletonMap("output", output));
} catch (IOException e) {
LOG.log(Level.SEVERE, "Error sending hooks response", e);
}
}).exceptionally(ex -> {
try {
- rpc.sendErrorResponse(Long.parseLong(requestId), -32603,
- "Hooks handler error: " + ex.getMessage());
+ rpc.sendErrorResponse(requestIdLong, -32603, "Hooks handler error: " + ex.getMessage());
} catch (IOException e) {
LOG.log(Level.SEVERE, "Error sending hooks error", e);
}
@@ -328,15 +446,11 @@ interface LifecycleEventDispatcher {
private void handleSystemMessageTransform(JsonRpcClient rpc, String requestId, JsonNode params) {
runAsync(() -> {
+ final long requestIdLong = parseRequestId(requestId, "systemMessage.transform");
+ if (requestIdLong == -1) {
+ return;
+ }
try {
- final long requestIdLong;
- try {
- requestIdLong = Long.parseLong(requestId);
- } catch (NumberFormatException nfe) {
- LOG.log(Level.SEVERE, "Invalid requestId for systemMessage.transform: " + requestId, nfe);
- return;
- }
-
String sessionId = params.has("sessionId") ? params.get("sessionId").asText() : null;
JsonNode sections = params.get("sections");
@@ -366,6 +480,25 @@ private void handleSystemMessageTransform(JsonRpcClient rpc, String requestId, J
});
}
+ /**
+ * Parses a JSON-RPC request ID string into a {@code long}.
+ *
+ * @param requestId
+ * the request ID string received from the JSON-RPC layer
+ * @param methodName
+ * the RPC method name, used in the log message on failure
+ * @return the parsed request ID, or {@code -1} if the string is not a valid
+ * long
+ */
+ private static long parseRequestId(String requestId, String methodName) {
+ try {
+ return Long.parseLong(requestId);
+ } catch (NumberFormatException nfe) {
+ LOG.log(Level.SEVERE, "Invalid requestId for " + methodName + ": " + requestId, nfe);
+ return -1;
+ }
+ }
+
private void runAsync(Runnable task) {
try {
if (executor != null) {
diff --git a/src/main/java/com/github/copilot/sdk/SessionRequestBuilder.java b/src/main/java/com/github/copilot/sdk/SessionRequestBuilder.java
index fd96966906..d9752db7ee 100644
--- a/src/main/java/com/github/copilot/sdk/SessionRequestBuilder.java
+++ b/src/main/java/com/github/copilot/sdk/SessionRequestBuilder.java
@@ -138,6 +138,12 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess
if (config.getOnElicitationRequest() != null) {
request.setRequestElicitation(true);
}
+ if (config.getOnExitPlanMode() != null) {
+ request.setRequestExitPlanMode(true);
+ }
+ if (config.getOnAutoModeSwitch() != null) {
+ request.setRequestAutoModeSwitch(true);
+ }
request.setGitHubToken(config.getGitHubToken());
return request;
@@ -216,6 +222,12 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo
if (config.getOnElicitationRequest() != null) {
request.setRequestElicitation(true);
}
+ if (config.getOnExitPlanMode() != null) {
+ request.setRequestExitPlanMode(true);
+ }
+ if (config.getOnAutoModeSwitch() != null) {
+ request.setRequestAutoModeSwitch(true);
+ }
request.setGitHubToken(config.getGitHubToken());
return request;
@@ -252,6 +264,12 @@ static void configureSession(CopilotSession session, SessionConfig config) {
if (config.getOnElicitationRequest() != null) {
session.registerElicitationHandler(config.getOnElicitationRequest());
}
+ if (config.getOnExitPlanMode() != null) {
+ session.registerExitPlanModeHandler(config.getOnExitPlanMode());
+ }
+ if (config.getOnAutoModeSwitch() != null) {
+ session.registerAutoModeSwitchHandler(config.getOnAutoModeSwitch());
+ }
if (config.getOnEvent() != null) {
session.on(config.getOnEvent());
}
@@ -288,6 +306,12 @@ static void configureSession(CopilotSession session, ResumeSessionConfig config)
if (config.getOnElicitationRequest() != null) {
session.registerElicitationHandler(config.getOnElicitationRequest());
}
+ if (config.getOnExitPlanMode() != null) {
+ session.registerExitPlanModeHandler(config.getOnExitPlanMode());
+ }
+ if (config.getOnAutoModeSwitch() != null) {
+ session.registerAutoModeSwitchHandler(config.getOnAutoModeSwitch());
+ }
if (config.getOnEvent() != null) {
session.on(config.getOnEvent());
}
diff --git a/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchHandler.java b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchHandler.java
new file mode 100644
index 0000000000..5fa19f4b1f
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchHandler.java
@@ -0,0 +1,48 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Handler for auto-mode-switch requests from the agent.
+ *
+ * Register an auto-mode-switch handler via
+ * {@link SessionConfig#setOnAutoModeSwitch(AutoModeSwitchHandler)} or
+ * {@link ResumeSessionConfig#setOnAutoModeSwitch(AutoModeSwitchHandler)}. When
+ * provided, the server routes {@code autoModeSwitch.request} callbacks to this
+ * handler.
+ *
+ *
Example Usage
+ *
+ * {@code
+ * AutoModeSwitchHandler handler = (request, invocation) -> {
+ * System.out.println("Rate limited: " + request.getErrorCode());
+ * return CompletableFuture.completedFuture(AutoModeSwitchResponse.YES);
+ * };
+ *
+ * var session = client.createSession(new SessionConfig().setOnAutoModeSwitch(handler)).get();
+ * }
+ *
+ * @see AutoModeSwitchRequest
+ * @see AutoModeSwitchResponse
+ * @since 1.0.8
+ */
+@FunctionalInterface
+public interface AutoModeSwitchHandler {
+
+ /**
+ * Handles an auto-mode-switch request from the agent.
+ *
+ * @param request
+ * the auto-mode-switch request containing the error code and
+ * retry-after seconds
+ * @param invocation
+ * context information about the invocation
+ * @return a future that resolves with the user's decision
+ */
+ CompletableFuture handle(AutoModeSwitchRequest request,
+ AutoModeSwitchInvocation invocation);
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchInvocation.java b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchInvocation.java
new file mode 100644
index 0000000000..278d10ccfd
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchInvocation.java
@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+/**
+ * Context for an auto-mode-switch request invocation.
+ *
+ * @since 1.0.8
+ */
+public class AutoModeSwitchInvocation {
+
+ private String sessionId;
+
+ /**
+ * Gets the session ID.
+ *
+ * @return the session ID
+ */
+ public String getSessionId() {
+ return sessionId;
+ }
+
+ /**
+ * Sets the session ID.
+ *
+ * @param sessionId
+ * the session ID
+ * @return this instance for method chaining
+ */
+ public AutoModeSwitchInvocation setSessionId(String sessionId) {
+ this.sessionId = sessionId;
+ return this;
+ }
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchRequest.java b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchRequest.java
new file mode 100644
index 0000000000..0ef784c02a
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchRequest.java
@@ -0,0 +1,68 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Request to switch to auto mode after an eligible rate limit.
+ *
+ * This is sent by the server when the agent encounters a rate limit and wants
+ * to switch to an alternative model automatically.
+ *
+ * @since 1.0.8
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class AutoModeSwitchRequest {
+
+ @JsonProperty("errorCode")
+ private String errorCode;
+
+ @JsonProperty("retryAfterSeconds")
+ private Double retryAfterSeconds;
+
+ /**
+ * Gets the rate-limit error code that triggered the request.
+ *
+ * @return the error code, or {@code null}
+ */
+ public String getErrorCode() {
+ return errorCode;
+ }
+
+ /**
+ * Sets the rate-limit error code.
+ *
+ * @param errorCode
+ * the error code
+ * @return this instance for method chaining
+ */
+ public AutoModeSwitchRequest setErrorCode(String errorCode) {
+ this.errorCode = errorCode;
+ return this;
+ }
+
+ /**
+ * Gets the seconds until the rate limit resets, when known.
+ *
+ * @return the retry-after seconds, or {@code null}
+ */
+ public Double getRetryAfterSeconds() {
+ return retryAfterSeconds;
+ }
+
+ /**
+ * Sets the seconds until the rate limit resets.
+ *
+ * @param retryAfterSeconds
+ * the retry-after seconds
+ * @return this instance for method chaining
+ */
+ public AutoModeSwitchRequest setRetryAfterSeconds(Double retryAfterSeconds) {
+ this.retryAfterSeconds = retryAfterSeconds;
+ return this;
+ }
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchResponse.java b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchResponse.java
new file mode 100644
index 0000000000..c072b73e2b
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/AutoModeSwitchResponse.java
@@ -0,0 +1,40 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+import com.fasterxml.jackson.annotation.JsonValue;
+
+/**
+ * Response to an auto-mode-switch request.
+ *
+ * @since 1.0.8
+ */
+public enum AutoModeSwitchResponse {
+
+ /** Approve the switch for this rate-limit cycle. */
+ YES("yes"),
+
+ /** Approve and remember the choice for this session. */
+ YES_ALWAYS("yes_always"),
+
+ /** Decline the switch. */
+ NO("no");
+
+ private final String value;
+
+ AutoModeSwitchResponse(String value) {
+ this.value = value;
+ }
+
+ /**
+ * Gets the wire value of this response.
+ *
+ * @return the string value
+ */
+ @JsonValue
+ public String getValue() {
+ return value;
+ }
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/CreateSessionRequest.java b/src/main/java/com/github/copilot/sdk/json/CreateSessionRequest.java
index 3a0b90f19a..12bab4154c 100644
--- a/src/main/java/com/github/copilot/sdk/json/CreateSessionRequest.java
+++ b/src/main/java/com/github/copilot/sdk/json/CreateSessionRequest.java
@@ -112,6 +112,12 @@ public final class CreateSessionRequest {
@JsonProperty("requestElicitation")
private Boolean requestElicitation;
+ @JsonProperty("requestExitPlanMode")
+ private Boolean requestExitPlanMode;
+
+ @JsonProperty("requestAutoModeSwitch")
+ private Boolean requestAutoModeSwitch;
+
@JsonProperty("modelCapabilities")
private ModelCapabilitiesOverride modelCapabilities;
@@ -419,6 +425,28 @@ public void setRequestElicitation(Boolean requestElicitation) {
this.requestElicitation = requestElicitation;
}
+ /** Gets the requestExitPlanMode flag. @return the flag */
+ public Boolean getRequestExitPlanMode() {
+ return requestExitPlanMode;
+ }
+
+ /** Sets the requestExitPlanMode flag. @param requestExitPlanMode the flag */
+ public void setRequestExitPlanMode(Boolean requestExitPlanMode) {
+ this.requestExitPlanMode = requestExitPlanMode;
+ }
+
+ /** Gets the requestAutoModeSwitch flag. @return the flag */
+ public Boolean getRequestAutoModeSwitch() {
+ return requestAutoModeSwitch;
+ }
+
+ /**
+ * Sets the requestAutoModeSwitch flag. @param requestAutoModeSwitch the flag
+ */
+ public void setRequestAutoModeSwitch(Boolean requestAutoModeSwitch) {
+ this.requestAutoModeSwitch = requestAutoModeSwitch;
+ }
+
/** Gets the model capabilities override. @return the override */
public ModelCapabilitiesOverride getModelCapabilities() {
return modelCapabilities;
diff --git a/src/main/java/com/github/copilot/sdk/json/ExitPlanModeHandler.java b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeHandler.java
new file mode 100644
index 0000000000..13ecbe075c
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeHandler.java
@@ -0,0 +1,48 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+import java.util.concurrent.CompletableFuture;
+
+/**
+ * Handler for exit-plan-mode requests from the agent.
+ *
+ * Register an exit-plan-mode handler via
+ * {@link SessionConfig#setOnExitPlanMode(ExitPlanModeHandler)} or
+ * {@link ResumeSessionConfig#setOnExitPlanMode(ExitPlanModeHandler)}. When
+ * provided, the server routes {@code exitPlanMode.request} callbacks to this
+ * handler.
+ *
+ *
Example Usage
+ *
+ * {@code
+ * ExitPlanModeHandler handler = (request, invocation) -> {
+ * // Review the plan and decide whether to approve
+ * return CompletableFuture
+ * .completedFuture(new ExitPlanModeResult().setApproved(true).setSelectedAction("interactive"));
+ * };
+ *
+ * var session = client.createSession(new SessionConfig().setOnExitPlanMode(handler)).get();
+ * }
+ *
+ * @see ExitPlanModeRequest
+ * @see ExitPlanModeResult
+ * @since 1.0.8
+ */
+@FunctionalInterface
+public interface ExitPlanModeHandler {
+
+ /**
+ * Handles an exit-plan-mode request from the agent.
+ *
+ * @param request
+ * the exit-plan-mode request containing the summary, plan content,
+ * and available actions
+ * @param invocation
+ * context information about the invocation
+ * @return a future that resolves with the user's decision
+ */
+ CompletableFuture handle(ExitPlanModeRequest request, ExitPlanModeInvocation invocation);
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/ExitPlanModeInvocation.java b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeInvocation.java
new file mode 100644
index 0000000000..6fd0231266
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeInvocation.java
@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+/**
+ * Context for an exit-plan-mode request invocation.
+ *
+ * @since 1.0.8
+ */
+public class ExitPlanModeInvocation {
+
+ private String sessionId;
+
+ /**
+ * Gets the session ID.
+ *
+ * @return the session ID
+ */
+ public String getSessionId() {
+ return sessionId;
+ }
+
+ /**
+ * Sets the session ID.
+ *
+ * @param sessionId
+ * the session ID
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeInvocation setSessionId(String sessionId) {
+ this.sessionId = sessionId;
+ return this;
+ }
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/ExitPlanModeRequest.java b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeRequest.java
new file mode 100644
index 0000000000..be09350ef3
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeRequest.java
@@ -0,0 +1,119 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+import java.util.Collections;
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Request to exit plan mode and continue with a selected action.
+ *
+ * This is sent by the server when the agent wants to exit plan mode and
+ * requests user confirmation.
+ *
+ * @since 1.0.8
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ExitPlanModeRequest {
+
+ @JsonProperty("summary")
+ private String summary = "";
+
+ @JsonProperty("planContent")
+ private String planContent;
+
+ @JsonProperty("actions")
+ private List actions;
+
+ @JsonProperty("recommendedAction")
+ private String recommendedAction = "autopilot";
+
+ /**
+ * Gets the summary of the plan or proposed next step.
+ *
+ * @return the summary
+ */
+ public String getSummary() {
+ return summary;
+ }
+
+ /**
+ * Sets the summary of the plan or proposed next step.
+ *
+ * @param summary
+ * the summary
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeRequest setSummary(String summary) {
+ this.summary = summary;
+ return this;
+ }
+
+ /**
+ * Gets the full plan content, when available.
+ *
+ * @return the plan content, or {@code null} if not available
+ */
+ public String getPlanContent() {
+ return planContent;
+ }
+
+ /**
+ * Sets the full plan content.
+ *
+ * @param planContent
+ * the plan content
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeRequest setPlanContent(String planContent) {
+ this.planContent = planContent;
+ return this;
+ }
+
+ /**
+ * Gets the available actions the user can select.
+ *
+ * @return the list of actions, or {@code null} if not specified
+ */
+ public List getActions() {
+ return actions == null ? null : Collections.unmodifiableList(actions);
+ }
+
+ /**
+ * Sets the available actions the user can select.
+ *
+ * @param actions
+ * the list of actions
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeRequest setActions(List actions) {
+ this.actions = actions;
+ return this;
+ }
+
+ /**
+ * Gets the action recommended by the runtime.
+ *
+ * @return the recommended action
+ */
+ public String getRecommendedAction() {
+ return recommendedAction;
+ }
+
+ /**
+ * Sets the action recommended by the runtime.
+ *
+ * @param recommendedAction
+ * the recommended action
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeRequest setRecommendedAction(String recommendedAction) {
+ this.recommendedAction = recommendedAction;
+ return this;
+ }
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/ExitPlanModeResult.java b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeResult.java
new file mode 100644
index 0000000000..876e750b46
--- /dev/null
+++ b/src/main/java/com/github/copilot/sdk/json/ExitPlanModeResult.java
@@ -0,0 +1,87 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.json;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Response to an exit-plan-mode request.
+ *
+ * @since 1.0.8
+ */
+public class ExitPlanModeResult {
+
+ @JsonProperty("approved")
+ private boolean approved = true;
+
+ @JsonProperty("selectedAction")
+ private String selectedAction;
+
+ @JsonProperty("feedback")
+ private String feedback;
+
+ /**
+ * Returns whether the user approved exiting plan mode.
+ *
+ * @return {@code true} if approved
+ */
+ public boolean isApproved() {
+ return approved;
+ }
+
+ /**
+ * Sets whether the user approved exiting plan mode.
+ *
+ * @param approved
+ * {@code true} if approved
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeResult setApproved(boolean approved) {
+ this.approved = approved;
+ return this;
+ }
+
+ /**
+ * Gets the selected action, if the user chose one.
+ *
+ * @return the selected action, or {@code null}
+ */
+ public String getSelectedAction() {
+ return selectedAction;
+ }
+
+ /**
+ * Sets the selected action.
+ *
+ * @param selectedAction
+ * the selected action
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeResult setSelectedAction(String selectedAction) {
+ this.selectedAction = selectedAction;
+ return this;
+ }
+
+ /**
+ * Gets optional feedback provided by the user.
+ *
+ * @return the feedback, or {@code null}
+ */
+ public String getFeedback() {
+ return feedback;
+ }
+
+ /**
+ * Sets feedback from the user.
+ *
+ * @param feedback
+ * the feedback text
+ * @return this instance for method chaining
+ */
+ public ExitPlanModeResult setFeedback(String feedback) {
+ this.feedback = feedback;
+ return this;
+ }
+}
diff --git a/src/main/java/com/github/copilot/sdk/json/ResumeSessionConfig.java b/src/main/java/com/github/copilot/sdk/json/ResumeSessionConfig.java
index cb52c62e02..f2caad7710 100644
--- a/src/main/java/com/github/copilot/sdk/json/ResumeSessionConfig.java
+++ b/src/main/java/com/github/copilot/sdk/json/ResumeSessionConfig.java
@@ -66,6 +66,8 @@ public class ResumeSessionConfig {
private Consumer onEvent;
private List commands;
private ElicitationHandler onElicitationRequest;
+ private ExitPlanModeHandler onExitPlanMode;
+ private AutoModeSwitchHandler onAutoModeSwitch;
private String gitHubToken;
/**
@@ -766,6 +768,60 @@ public ResumeSessionConfig setOnElicitationRequest(ElicitationHandler onElicitat
return this;
}
+ /**
+ * Gets the exit-plan-mode request handler.
+ *
+ * @return the exit-plan-mode handler, or {@code null}
+ * @since 1.0.8
+ */
+ public ExitPlanModeHandler getOnExitPlanMode() {
+ return onExitPlanMode;
+ }
+
+ /**
+ * Sets a handler for exit-plan-mode requests from the server.
+ *
+ * When provided, the server will route {@code exitPlanMode.request} callbacks
+ * to this handler.
+ *
+ * @param onExitPlanMode
+ * the exit-plan-mode handler
+ * @return this config for method chaining
+ * @see ExitPlanModeHandler
+ * @since 1.0.8
+ */
+ public ResumeSessionConfig setOnExitPlanMode(ExitPlanModeHandler onExitPlanMode) {
+ this.onExitPlanMode = onExitPlanMode;
+ return this;
+ }
+
+ /**
+ * Gets the auto-mode-switch request handler.
+ *
+ * @return the auto-mode-switch handler, or {@code null}
+ * @since 1.0.8
+ */
+ public AutoModeSwitchHandler getOnAutoModeSwitch() {
+ return onAutoModeSwitch;
+ }
+
+ /**
+ * Sets a handler for auto-mode-switch requests from the server.
+ *
+ * When provided, the server will route {@code autoModeSwitch.request} callbacks
+ * to this handler.
+ *
+ * @param onAutoModeSwitch
+ * the auto-mode-switch handler
+ * @return this config for method chaining
+ * @see AutoModeSwitchHandler
+ * @since 1.0.8
+ */
+ public ResumeSessionConfig setOnAutoModeSwitch(AutoModeSwitchHandler onAutoModeSwitch) {
+ this.onAutoModeSwitch = onAutoModeSwitch;
+ return this;
+ }
+
/**
* Gets the GitHub token for per-session authentication.
*
@@ -839,6 +895,8 @@ public ResumeSessionConfig clone() {
copy.onEvent = this.onEvent;
copy.commands = this.commands != null ? new ArrayList<>(this.commands) : null;
copy.onElicitationRequest = this.onElicitationRequest;
+ copy.onExitPlanMode = this.onExitPlanMode;
+ copy.onAutoModeSwitch = this.onAutoModeSwitch;
copy.gitHubToken = this.gitHubToken;
return copy;
}
diff --git a/src/main/java/com/github/copilot/sdk/json/ResumeSessionRequest.java b/src/main/java/com/github/copilot/sdk/json/ResumeSessionRequest.java
index 9b2c17f1a4..a1af269700 100644
--- a/src/main/java/com/github/copilot/sdk/json/ResumeSessionRequest.java
+++ b/src/main/java/com/github/copilot/sdk/json/ResumeSessionRequest.java
@@ -116,6 +116,12 @@ public final class ResumeSessionRequest {
@JsonProperty("requestElicitation")
private Boolean requestElicitation;
+ @JsonProperty("requestExitPlanMode")
+ private Boolean requestExitPlanMode;
+
+ @JsonProperty("requestAutoModeSwitch")
+ private Boolean requestAutoModeSwitch;
+
@JsonProperty("modelCapabilities")
private ModelCapabilitiesOverride modelCapabilities;
@@ -439,6 +445,28 @@ public void setRequestElicitation(Boolean requestElicitation) {
this.requestElicitation = requestElicitation;
}
+ /** Gets the requestExitPlanMode flag. @return the flag */
+ public Boolean getRequestExitPlanMode() {
+ return requestExitPlanMode;
+ }
+
+ /** Sets the requestExitPlanMode flag. @param requestExitPlanMode the flag */
+ public void setRequestExitPlanMode(Boolean requestExitPlanMode) {
+ this.requestExitPlanMode = requestExitPlanMode;
+ }
+
+ /** Gets the requestAutoModeSwitch flag. @return the flag */
+ public Boolean getRequestAutoModeSwitch() {
+ return requestAutoModeSwitch;
+ }
+
+ /**
+ * Sets the requestAutoModeSwitch flag. @param requestAutoModeSwitch the flag
+ */
+ public void setRequestAutoModeSwitch(Boolean requestAutoModeSwitch) {
+ this.requestAutoModeSwitch = requestAutoModeSwitch;
+ }
+
/** Gets the model capabilities override. @return the override */
public ModelCapabilitiesOverride getModelCapabilities() {
return modelCapabilities;
diff --git a/src/main/java/com/github/copilot/sdk/json/SessionConfig.java b/src/main/java/com/github/copilot/sdk/json/SessionConfig.java
index a4b2769b74..51cad884ed 100644
--- a/src/main/java/com/github/copilot/sdk/json/SessionConfig.java
+++ b/src/main/java/com/github/copilot/sdk/json/SessionConfig.java
@@ -66,6 +66,8 @@ public class SessionConfig {
private Consumer onEvent;
private List commands;
private ElicitationHandler onElicitationRequest;
+ private ExitPlanModeHandler onExitPlanMode;
+ private AutoModeSwitchHandler onAutoModeSwitch;
private String gitHubToken;
/**
@@ -818,6 +820,60 @@ public SessionConfig setOnElicitationRequest(ElicitationHandler onElicitationReq
return this;
}
+ /**
+ * Gets the exit-plan-mode request handler.
+ *
+ * @return the exit-plan-mode handler, or {@code null}
+ * @since 1.0.8
+ */
+ public ExitPlanModeHandler getOnExitPlanMode() {
+ return onExitPlanMode;
+ }
+
+ /**
+ * Sets a handler for exit-plan-mode requests from the server.
+ *
+ * When provided, the server will route {@code exitPlanMode.request} callbacks
+ * to this handler.
+ *
+ * @param onExitPlanMode
+ * the exit-plan-mode handler
+ * @return this config instance for method chaining
+ * @see ExitPlanModeHandler
+ * @since 1.0.8
+ */
+ public SessionConfig setOnExitPlanMode(ExitPlanModeHandler onExitPlanMode) {
+ this.onExitPlanMode = onExitPlanMode;
+ return this;
+ }
+
+ /**
+ * Gets the auto-mode-switch request handler.
+ *
+ * @return the auto-mode-switch handler, or {@code null}
+ * @since 1.0.8
+ */
+ public AutoModeSwitchHandler getOnAutoModeSwitch() {
+ return onAutoModeSwitch;
+ }
+
+ /**
+ * Sets a handler for auto-mode-switch requests from the server.
+ *
+ * When provided, the server will route {@code autoModeSwitch.request} callbacks
+ * to this handler.
+ *
+ * @param onAutoModeSwitch
+ * the auto-mode-switch handler
+ * @return this config instance for method chaining
+ * @see AutoModeSwitchHandler
+ * @since 1.0.8
+ */
+ public SessionConfig setOnAutoModeSwitch(AutoModeSwitchHandler onAutoModeSwitch) {
+ this.onAutoModeSwitch = onAutoModeSwitch;
+ return this;
+ }
+
/**
* Gets the GitHub token for per-session authentication.
*
@@ -891,6 +947,8 @@ public SessionConfig clone() {
copy.onEvent = this.onEvent;
copy.commands = this.commands != null ? new ArrayList<>(this.commands) : null;
copy.onElicitationRequest = this.onElicitationRequest;
+ copy.onExitPlanMode = this.onExitPlanMode;
+ copy.onAutoModeSwitch = this.onAutoModeSwitch;
copy.gitHubToken = this.gitHubToken;
return copy;
}
diff --git a/src/site/markdown/advanced.md b/src/site/markdown/advanced.md
index ccf386640f..9b5d00c5ac 100644
--- a/src/site/markdown/advanced.md
+++ b/src/site/markdown/advanced.md
@@ -53,6 +53,9 @@ This guide covers advanced scenarios for extending and customizing your Copilot
- [Incoming Elicitation Handler](#Incoming_Elicitation_Handler)
- [Session Capabilities](#Session_Capabilities)
- [Outgoing Elicitation via session.getUi()](#Outgoing_Elicitation_via_session.getUi)
+- [Mode Handlers](#Mode_Handlers)
+ - [Exit Plan Mode](#Exit_Plan_Mode)
+ - [Auto Mode Switch](#Auto_Mode_Switch)
- [Getting Session Metadata by ID](#Getting_Session_Metadata_by_ID)
---
@@ -1267,6 +1270,66 @@ All `getUi()` methods throw `IllegalStateException` if the host does not support
---
+## Mode Handlers
+
+Mode handlers let your application respond to mode transitions requested by the Copilot CLI.
+
+### Exit Plan Mode
+
+When the model finishes creating a plan and wants to transition out of plan mode, it invokes the `exitPlanMode` handler. Register the handler via `SessionConfig.setOnExitPlanMode()`:
+
+```java
+var session = client.createSession(new SessionConfig()
+ .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
+ .setOnExitPlanMode((request, invocation) -> {
+ System.out.println("Plan summary: " + request.getSummary());
+ System.out.println("Available actions: " + request.getActions());
+ System.out.println("Recommended: " + request.getRecommendedAction());
+
+ return CompletableFuture.completedFuture(
+ new ExitPlanModeResult()
+ .setApproved(true)
+ .setSelectedAction("interactive")
+ .setFeedback("Looks good, proceed!"));
+ })).get();
+```
+
+When no handler is registered, the SDK automatically approves the plan (`approved=true`). The handler receives an `ExitPlanModeRequest` with:
+
+| Field | Description |
+|---------------------|-------------------------------------------------|
+| `summary` | Summary of the plan that was created |
+| `planContent` | Full content of the plan file |
+| `actions` | Available actions (e.g., interactive, autopilot) |
+| `recommendedAction` | The recommended action for the user |
+
+### Auto Mode Switch
+
+When the model encounters a rate limit or similar constraint, it may request to switch modes automatically. Register the handler via `SessionConfig.setOnAutoModeSwitch()`:
+
+```java
+var session = client.createSession(new SessionConfig()
+ .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
+ .setOnAutoModeSwitch((request, invocation) -> {
+ System.out.println("Error: " + request.getErrorCode());
+ System.out.println("Retry after: " + request.getRetryAfterSeconds() + "s");
+
+ return CompletableFuture.completedFuture(AutoModeSwitchResponse.YES);
+ })).get();
+```
+
+When no handler is registered, the SDK returns `NO` (declining the mode switch). The response options are:
+
+| Response | Description |
+|---------------------------------|------------------------------------------|
+| `AutoModeSwitchResponse.YES` | Allow the mode switch this time |
+| `AutoModeSwitchResponse.YES_ALWAYS`| Always allow automatic mode switches |
+| `AutoModeSwitchResponse.NO` | Decline the mode switch |
+
+Both handlers are also available on `ResumeSessionConfig` for resumed sessions.
+
+---
+
## Getting Session Metadata by ID
Retrieve metadata for a specific session without listing all sessions:
diff --git a/src/site/markdown/cookbook/error-handling.md b/src/site/markdown/cookbook/error-handling.md
index 4542533f86..74732006ee 100644
--- a/src/site/markdown/cookbook/error-handling.md
+++ b/src/site/markdown/cookbook/error-handling.md
@@ -30,7 +30,7 @@ jbang BasicErrorHandling.java
**Code:**
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
@@ -64,7 +64,7 @@ public class BasicErrorHandling {
## Handling specific error types
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import java.util.concurrent.ExecutionException;
@@ -99,7 +99,7 @@ public class SpecificErrorHandling {
## Timeout handling
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotSession;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
@@ -130,7 +130,7 @@ public class TimeoutHandling {
## Aborting a request
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotSession;
import com.github.copilot.sdk.json.MessageOptions;
import java.util.concurrent.Executors;
@@ -162,7 +162,7 @@ public class AbortRequest {
## Graceful shutdown
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
public class GracefulShutdown {
@@ -192,7 +192,7 @@ public class GracefulShutdown {
## Try-with-resources pattern
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
@@ -224,7 +224,7 @@ public class TryWithResources {
## Handling tool errors
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
diff --git a/src/site/markdown/cookbook/managing-local-files.md b/src/site/markdown/cookbook/managing-local-files.md
index c52e6eabe4..78f914f103 100644
--- a/src/site/markdown/cookbook/managing-local-files.md
+++ b/src/site/markdown/cookbook/managing-local-files.md
@@ -34,7 +34,7 @@ jbang ManagingLocalFiles.java
**Code:**
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.generated.SessionIdleEvent;
@@ -161,7 +161,7 @@ session.send(new MessageOptions().setPrompt(prompt));
## Interactive file organization
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import java.io.BufferedReader;
import java.io.InputStreamReader;
diff --git a/src/site/markdown/cookbook/multiple-sessions.md b/src/site/markdown/cookbook/multiple-sessions.md
index f0072ea95c..42bb1f6222 100644
--- a/src/site/markdown/cookbook/multiple-sessions.md
+++ b/src/site/markdown/cookbook/multiple-sessions.md
@@ -30,7 +30,7 @@ jbang MultipleSessions.java
**Code:**
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
@@ -123,7 +123,7 @@ try {
## Managing session lifecycle with CompletableFuture
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import java.util.concurrent.CompletableFuture;
import java.util.List;
diff --git a/src/site/markdown/cookbook/persisting-sessions.md b/src/site/markdown/cookbook/persisting-sessions.md
index d0125588bc..119448a440 100644
--- a/src/site/markdown/cookbook/persisting-sessions.md
+++ b/src/site/markdown/cookbook/persisting-sessions.md
@@ -30,7 +30,7 @@ jbang PersistingSessions.java
**Code:**
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.json.MessageOptions;
@@ -127,7 +127,7 @@ public class DeleteSession {
## Getting session history
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.generated.UserMessageEvent;
@@ -162,7 +162,7 @@ public class SessionHistory {
## Complete example with session management
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import java.util.Scanner;
public class SessionManager {
diff --git a/src/site/markdown/cookbook/pr-visualization.md b/src/site/markdown/cookbook/pr-visualization.md
index 91ae5fb874..627ee5b842 100644
--- a/src/site/markdown/cookbook/pr-visualization.md
+++ b/src/site/markdown/cookbook/pr-visualization.md
@@ -34,7 +34,7 @@ jbang PRVisualization.java github/copilot-sdk
## Full example: PRVisualization.java
```java
-//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.2-beta-java.1
+//DEPS com.github:copilot-sdk-java:1.0.0-beta-java.3-beta-java.2-beta-java.1
import com.github.copilot.sdk.CopilotClient;
import com.github.copilot.sdk.generated.AssistantMessageEvent;
import com.github.copilot.sdk.generated.ToolExecutionStartEvent;
diff --git a/src/test/java/com/github/copilot/sdk/ConfigCloneTest.java b/src/test/java/com/github/copilot/sdk/ConfigCloneTest.java
index f7ce3aa4de..7abc47e4a4 100644
--- a/src/test/java/com/github/copilot/sdk/ConfigCloneTest.java
+++ b/src/test/java/com/github/copilot/sdk/ConfigCloneTest.java
@@ -16,8 +16,10 @@
import org.junit.jupiter.api.Test;
import com.github.copilot.sdk.generated.SessionEvent;
+import com.github.copilot.sdk.json.AutoModeSwitchResponse;
import com.github.copilot.sdk.json.CopilotClientOptions;
import com.github.copilot.sdk.json.DefaultAgentConfig;
+import com.github.copilot.sdk.json.ExitPlanModeResult;
import com.github.copilot.sdk.json.InfiniteSessionConfig;
import com.github.copilot.sdk.json.MessageOptions;
import com.github.copilot.sdk.json.ModelInfo;
@@ -375,4 +377,32 @@ void copilotClientOptionsSessionIdleTimeoutCloned() {
assertEquals(600, cloned.getSessionIdleTimeoutSeconds());
}
+
+ @Test
+ void sessionConfigCloneCopiesModeSwitchHandlers() {
+ SessionConfig original = new SessionConfig();
+ original.setOnExitPlanMode(
+ (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult()));
+ original.setOnAutoModeSwitch(
+ (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ SessionConfig cloned = original.clone();
+
+ assertSame(original.getOnExitPlanMode(), cloned.getOnExitPlanMode());
+ assertSame(original.getOnAutoModeSwitch(), cloned.getOnAutoModeSwitch());
+ }
+
+ @Test
+ void resumeSessionConfigCloneCopiesModeSwitchHandlers() {
+ ResumeSessionConfig original = new ResumeSessionConfig();
+ original.setOnExitPlanMode(
+ (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult()));
+ original.setOnAutoModeSwitch(
+ (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ ResumeSessionConfig cloned = original.clone();
+
+ assertSame(original.getOnExitPlanMode(), cloned.getOnExitPlanMode());
+ assertSame(original.getOnAutoModeSwitch(), cloned.getOnAutoModeSwitch());
+ }
}
diff --git a/src/test/java/com/github/copilot/sdk/ModeHandlersTest.java b/src/test/java/com/github/copilot/sdk/ModeHandlersTest.java
new file mode 100644
index 0000000000..0c84b05736
--- /dev/null
+++ b/src/test/java/com/github/copilot/sdk/ModeHandlersTest.java
@@ -0,0 +1,150 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent;
+import com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent;
+import com.github.copilot.sdk.json.AutoModeSwitchRequest;
+import com.github.copilot.sdk.json.AutoModeSwitchResponse;
+import com.github.copilot.sdk.json.CopilotClientOptions;
+import com.github.copilot.sdk.json.ExitPlanModeRequest;
+import com.github.copilot.sdk.json.ExitPlanModeResult;
+import com.github.copilot.sdk.json.MessageOptions;
+import com.github.copilot.sdk.json.PermissionHandler;
+import com.github.copilot.sdk.json.SessionConfig;
+
+/**
+ * E2E tests for exit-plan-mode and auto-mode-switch handler APIs.
+ *
+ *
+ * Ported from {@code ModeHandlersE2ETests.cs} in the reference implementation
+ * dotnet SDK.
+ *
+ */
+public class ModeHandlersTest {
+
+ private static final String TOKEN = "mode-handler-token";
+
+ private static E2ETestContext ctx;
+
+ @BeforeAll
+ static void setup() throws Exception {
+ ctx = E2ETestContext.create();
+ }
+
+ @AfterAll
+ static void teardown() throws Exception {
+ if (ctx != null) {
+ ctx.close();
+ }
+ }
+
+ private CopilotClient createAuthenticatedClient() {
+ Map env = new HashMap<>(ctx.getEnvironment());
+ env.put("COPILOT_DEBUG_GITHUB_API_URL", ctx.getProxyUrl());
+
+ return ctx.createClient(new CopilotClientOptions().setEnvironment(env));
+ }
+
+ private void configureAuthenticatedUser(String testName) throws Exception {
+ ctx.configureForTest("mode_handlers", testName);
+ ctx.setCopilotUserByToken(TOKEN, "mode-handler-user", "individual_pro", ctx.getProxyUrl(),
+ "https://localhost:1/telemetry", "mode-handler-tracking-id");
+ }
+
+ @Test
+ void shouldInvokeExitPlanModeHandlerWhenModelUsesTool() throws Exception {
+ final String summary = "Greeting file implementation plan";
+ configureAuthenticatedUser("should_invoke_exit_plan_mode_handler_when_model_uses_tool");
+
+ var handlerCalled = new CompletableFuture();
+
+ try (var client = createAuthenticatedClient()) {
+ var session = client.createSession(new SessionConfig().setGitHubToken(TOKEN)
+ .setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setOnExitPlanMode((request, invocation) -> {
+ handlerCalled.complete(request);
+ return CompletableFuture.completedFuture(new ExitPlanModeResult().setApproved(true)
+ .setSelectedAction("interactive").setFeedback("Approved by the Java E2E test"));
+ })).get(30, TimeUnit.SECONDS);
+
+ var requestedEvent = new CompletableFuture();
+ var completedEvent = new CompletableFuture();
+
+ session.on(event -> {
+ if (event instanceof ExitPlanModeRequestedEvent requested
+ && summary.equals(requested.getData().summary())) {
+ requestedEvent.complete(requested);
+ } else if (event instanceof ExitPlanModeCompletedEvent completed
+ && Boolean.TRUE.equals(completed.getData().approved())
+ && "interactive".equals(completed.getData().selectedAction())) {
+ completedEvent.complete(completed);
+ }
+ });
+
+ var response = session.sendAndWait(new MessageOptions().setPrompt(
+ "Create a brief implementation plan for adding a greeting.txt file, then request approval with exit_plan_mode.")
+ .setMode("plan")).get(120, TimeUnit.SECONDS);
+
+ var request = handlerCalled.get(10, TimeUnit.SECONDS);
+ assertEquals(summary, request.getSummary());
+ assertNotNull(request.getActions());
+ assertTrue(request.getActions().contains("interactive"));
+ assertNotNull(request.getPlanContent());
+
+ var reqEvent = requestedEvent.get(10, TimeUnit.SECONDS);
+ assertEquals(request.getSummary(), reqEvent.getData().summary());
+
+ var compEvent = completedEvent.get(10, TimeUnit.SECONDS);
+ assertTrue(compEvent.getData().approved());
+ assertEquals("interactive", compEvent.getData().selectedAction());
+
+ assertNotNull(response);
+
+ session.close();
+ }
+ }
+
+ @Test
+ void shouldInvokeAutoModeSwitchHandlerWhenRateLimited() throws Exception {
+ configureAuthenticatedUser("should_invoke_auto_mode_switch_handler_when_rate_limited");
+
+ var handlerCalled = new CompletableFuture();
+
+ try (var client = createAuthenticatedClient()) {
+ var session = client.createSession(
+ new SessionConfig().setGitHubToken(TOKEN).setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
+ .setOnAutoModeSwitch((request, invocation) -> {
+ handlerCalled.complete(request);
+ return CompletableFuture.completedFuture(AutoModeSwitchResponse.YES);
+ }))
+ .get(30, TimeUnit.SECONDS);
+
+ var messageId = session
+ .send(new MessageOptions()
+ .setPrompt("Explain that auto mode recovered from a rate limit in one short sentence."))
+ .get(30, TimeUnit.SECONDS);
+
+ assertNotNull(messageId);
+ assertFalse(messageId.isEmpty());
+
+ var request = handlerCalled.get(30, TimeUnit.SECONDS);
+ assertEquals("user_weekly_rate_limited", request.getErrorCode());
+ assertEquals(1.0, request.getRetryAfterSeconds());
+
+ session.close();
+ }
+ }
+}
diff --git a/src/test/java/com/github/copilot/sdk/SessionEventHandlingTest.java b/src/test/java/com/github/copilot/sdk/SessionEventHandlingTest.java
index f31ca2d2d8..d9f22e7813 100644
--- a/src/test/java/com/github/copilot/sdk/SessionEventHandlingTest.java
+++ b/src/test/java/com/github/copilot/sdk/SessionEventHandlingTest.java
@@ -180,7 +180,7 @@ void testHandlerReceivesCorrectEventData() {
SessionStartEvent startEvent = createSessionStartEvent();
startEvent.setData(new SessionStartEvent.SessionStartEventData("my-session-123", null, null, null, null, null,
- null, null, null, null));
+ null, null, null, null, null));
dispatchEvent(startEvent);
AssistantMessageEvent msgEvent = createAssistantMessageEvent("Test content");
@@ -857,15 +857,15 @@ private SessionStartEvent createSessionStartEvent() {
private SessionStartEvent createSessionStartEvent(String sessionId) {
var event = new SessionStartEvent();
var data = new SessionStartEvent.SessionStartEventData(sessionId, null, null, null, null, null, null, null,
- null, null);
+ null, null, null);
event.setData(data);
return event;
}
private AssistantMessageEvent createAssistantMessageEvent(String content) {
var event = new AssistantMessageEvent();
- var data = new AssistantMessageEvent.AssistantMessageEventData(null, content, null, null, null, null, null,
- null, null, null, null, null);
+ var data = new AssistantMessageEvent.AssistantMessageEventData(null, null, content, null, null, null, null,
+ null, null, null, null, null, null, null, null);
event.setData(data);
return event;
}
diff --git a/src/test/java/com/github/copilot/sdk/SessionRequestBuilderTest.java b/src/test/java/com/github/copilot/sdk/SessionRequestBuilderTest.java
index 0d13576eb8..43703831a8 100644
--- a/src/test/java/com/github/copilot/sdk/SessionRequestBuilderTest.java
+++ b/src/test/java/com/github/copilot/sdk/SessionRequestBuilderTest.java
@@ -12,11 +12,13 @@
import org.junit.jupiter.api.Test;
+import com.github.copilot.sdk.json.AutoModeSwitchResponse;
import com.github.copilot.sdk.json.CreateSessionRequest;
import com.github.copilot.sdk.json.DefaultAgentConfig;
import com.github.copilot.sdk.json.ElicitationHandler;
import com.github.copilot.sdk.json.ElicitationResult;
import com.github.copilot.sdk.json.ElicitationResultAction;
+import com.github.copilot.sdk.json.ExitPlanModeResult;
import com.github.copilot.sdk.json.ResumeSessionConfig;
import com.github.copilot.sdk.json.ResumeSessionRequest;
import com.github.copilot.sdk.json.SessionConfig;
@@ -535,4 +537,126 @@ void testResumeRequestOmitsEnableSessionTelemetryWhenNull() throws Exception {
var json = mapper.writeValueAsString(request);
assertFalse(json.contains("enableSessionTelemetry"), "enableSessionTelemetry should be omitted when null");
}
+
+ // =========================================================================
+ // Mode handler request flags
+ // =========================================================================
+
+ @Test
+ void testBuildCreateRequestWithExitPlanModeHandler() {
+ var config = new SessionConfig().setOnExitPlanMode(
+ (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult()));
+
+ CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config);
+
+ assertTrue(request.getRequestExitPlanMode());
+ }
+
+ @Test
+ void testBuildCreateRequestWithAutoModeSwitchHandler() {
+ var config = new SessionConfig().setOnAutoModeSwitch(
+ (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config);
+
+ assertTrue(request.getRequestAutoModeSwitch());
+ }
+
+ @Test
+ void testBuildCreateRequestWithoutModeHandlers() {
+ var config = new SessionConfig();
+
+ CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config);
+
+ assertNull(request.getRequestExitPlanMode());
+ assertNull(request.getRequestAutoModeSwitch());
+ }
+
+ @Test
+ void testBuildResumeRequestWithExitPlanModeHandler() {
+ var config = new ResumeSessionConfig().setOnExitPlanMode(
+ (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult()));
+
+ ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config);
+
+ assertTrue(request.getRequestExitPlanMode());
+ }
+
+ @Test
+ void testBuildResumeRequestWithAutoModeSwitchHandler() {
+ var config = new ResumeSessionConfig().setOnAutoModeSwitch(
+ (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config);
+
+ assertTrue(request.getRequestAutoModeSwitch());
+ }
+
+ @Test
+ void configureSessionWithExitPlanModeHandler_registersHandler() {
+ CopilotSession session = new CopilotSession("session-1", null);
+
+ var config = new SessionConfig().setOnExitPlanMode(
+ (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult()));
+
+ SessionRequestBuilder.configureSession(session, config);
+ }
+
+ @Test
+ void configureSessionWithAutoModeSwitchHandler_registersHandler() {
+ CopilotSession session = new CopilotSession("session-1", null);
+
+ var config = new SessionConfig().setOnAutoModeSwitch(
+ (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ SessionRequestBuilder.configureSession(session, config);
+ }
+
+ @Test
+ void configureResumedSessionWithExitPlanModeHandler_registersHandler() {
+ CopilotSession session = new CopilotSession("session-1", null);
+
+ var config = new ResumeSessionConfig().setOnExitPlanMode(
+ (request, invocation) -> CompletableFuture.completedFuture(new ExitPlanModeResult()));
+
+ SessionRequestBuilder.configureSession(session, config);
+ }
+
+ @Test
+ void configureResumedSessionWithAutoModeSwitchHandler_registersHandler() {
+ CopilotSession session = new CopilotSession("session-1", null);
+
+ var config = new ResumeSessionConfig().setOnAutoModeSwitch(
+ (request, invocation) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ SessionRequestBuilder.configureSession(session, config);
+ }
+
+ @Test
+ void testCreateRequestSerializesModeFlags() throws Exception {
+ var config = new SessionConfig()
+ .setOnExitPlanMode((r, i) -> CompletableFuture.completedFuture(new ExitPlanModeResult()))
+ .setOnAutoModeSwitch((r, i) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config);
+ var mapper = JsonRpcClient.getObjectMapper();
+ var json = mapper.writeValueAsString(request);
+
+ assertTrue(json.contains("\"requestExitPlanMode\":true"));
+ assertTrue(json.contains("\"requestAutoModeSwitch\":true"));
+ }
+
+ @Test
+ void testResumeRequestSerializesModeFlags() throws Exception {
+ var config = new ResumeSessionConfig()
+ .setOnExitPlanMode((r, i) -> CompletableFuture.completedFuture(new ExitPlanModeResult()))
+ .setOnAutoModeSwitch((r, i) -> CompletableFuture.completedFuture(AutoModeSwitchResponse.NO));
+
+ ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("session-1", config);
+ var mapper = JsonRpcClient.getObjectMapper();
+ var json = mapper.writeValueAsString(request);
+
+ assertTrue(json.contains("\"requestExitPlanMode\":true"));
+ assertTrue(json.contains("\"requestAutoModeSwitch\":true"));
+ }
}