Implement metadata APIs and tool execution progress event; refactor model handling

Author: brunoborges

README.md

@@ -75,7 +75,7 @@ public class Example {
 
             // Create a session
             var session = client.createSession(
-                new SessionConfig().setModel(CopilotModel.CLAUDE_SONNET_4_5.toString())
+                new SessionConfig().setModel("claude-sonnet-4.5")
             ).get();
 
             // Wait for response using session.idle event

jbang-example.java

@@ -13,7 +13,7 @@ public static void main(String[] args) throws Exception {
 
             // Create a session
             var session = client.createSession(
-                    new SessionConfig().setModel(CopilotModel.CLAUDE_SONNET_4_5.toString())).get();
+                    new SessionConfig().setModel("claude-sonnet-4.5")).get();
 
             // Wait for response using session.idle event
             var done = new CompletableFuture<Void>();

src/main/java/com/github/copilot/sdk/CopilotClient.java

@@ -33,8 +33,12 @@
 import com.github.copilot.sdk.json.CreateSessionRequest;
 import com.github.copilot.sdk.json.CreateSessionResponse;
 import com.github.copilot.sdk.json.DeleteSessionResponse;
+import com.github.copilot.sdk.json.GetAuthStatusResponse;
 import com.github.copilot.sdk.json.GetLastSessionIdResponse;
+import com.github.copilot.sdk.json.GetModelsResponse;
+import com.github.copilot.sdk.json.GetStatusResponse;
 import com.github.copilot.sdk.json.ListSessionsResponse;
+import com.github.copilot.sdk.json.ModelInfo;
 import com.github.copilot.sdk.json.PermissionRequestResult;
 import com.github.copilot.sdk.json.PingResponse;
 import com.github.copilot.sdk.json.ResumeSessionConfig;
@@ -537,6 +541,40 @@ public CompletableFuture<PingResponse> ping(String message) {
                 Map.of("message", message != null ? message : ""), PingResponse.class));
     }
 
+    /**
+     * Gets CLI status including version and protocol information.
+     *
+     * @return a future that resolves with the status response containing version
+     *         and protocol version
+     * @see GetStatusResponse
+     */
+    public CompletableFuture<GetStatusResponse> getStatus() {
+        return ensureConnected()
+                .thenCompose(connection -> connection.rpc.invoke("status.get", Map.of(), GetStatusResponse.class));
+    }
+
+    /**
+     * Gets current authentication status.
+     *
+     * @return a future that resolves with the authentication status
+     * @see GetAuthStatusResponse
+     */
+    public CompletableFuture<GetAuthStatusResponse> getAuthStatus() {
+        return ensureConnected().thenCompose(
+                connection -> connection.rpc.invoke("auth.getStatus", Map.of(), GetAuthStatusResponse.class));
+    }
+
+    /**
+     * Lists available models with their metadata.
+     *
+     * @return a future that resolves with a list of available models
+     * @see ModelInfo
+     */
+    public CompletableFuture<List<ModelInfo>> listModels() {
+        return ensureConnected().thenCompose(connection -> connection.rpc
+                .invoke("models.list", Map.of(), GetModelsResponse.class).thenApply(GetModelsResponse::getModels));
+    }
+
     /**
      * Gets the ID of the most recently used session.
      * <p>

src/main/java/com/github/copilot/sdk/CopilotModel.java

@@ -57,7 +57,8 @@ public abstract sealed class AbstractSessionEvent permits
         AssistantTurnStartEvent, AssistantIntentEvent, AssistantReasoningEvent, AssistantReasoningDeltaEvent,
         AssistantMessageEvent, AssistantMessageDeltaEvent, AssistantTurnEndEvent, AssistantUsageEvent, AbortEvent,
         // Tool events
-        ToolUserRequestedEvent, ToolExecutionStartEvent, ToolExecutionPartialResultEvent, ToolExecutionCompleteEvent,
+        ToolUserRequestedEvent, ToolExecutionStartEvent, ToolExecutionPartialResultEvent, ToolExecutionProgressEvent,
+        ToolExecutionCompleteEvent,
         // User events
         UserMessageEvent, PendingMessagesModifiedEvent,
         // Other events

src/main/java/com/github/copilot/sdk/events/AbstractSessionEvent.java

@@ -73,6 +73,7 @@ public class SessionEventParser {
         TYPE_MAP.put("tool.user_requested", ToolUserRequestedEvent.class);
         TYPE_MAP.put("tool.execution_start", ToolExecutionStartEvent.class);
         TYPE_MAP.put("tool.execution_partial_result", ToolExecutionPartialResultEvent.class);
+        TYPE_MAP.put("tool.execution_progress", ToolExecutionProgressEvent.class);
         TYPE_MAP.put("tool.execution_complete", ToolExecutionCompleteEvent.class);
         TYPE_MAP.put("subagent.started", SubagentStartedEvent.class);
         TYPE_MAP.put("subagent.completed", SubagentCompletedEvent.class);

src/main/java/com/github/copilot/sdk/events/SessionEventParser.java

@@ -0,0 +1,64 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+package com.github.copilot.sdk.events;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+/**
+ * Event fired when a tool execution reports progress.
+ * <p>
+ * This event provides progress updates during tool execution.
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public final class ToolExecutionProgressEvent extends AbstractSessionEvent {
+
+    public static final String TYPE = "tool.execution_progress";
+
+    @JsonProperty("data")
+    private ToolExecutionProgressData data;
+
+    @Override
+    public String getType() {
+        return TYPE;
+    }
+
+    public ToolExecutionProgressData getData() {
+        return data;
+    }
+
+    public ToolExecutionProgressEvent setData(ToolExecutionProgressData data) {
+        this.data = data;
+        return this;
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    public static class ToolExecutionProgressData {
+
+        @JsonProperty("toolCallId")
+        private String toolCallId;
+
+        @JsonProperty("progressMessage")
+        private String progressMessage;
+
+        public String getToolCallId() {
+            return toolCallId;
+        }
+
+        public ToolExecutionProgressData setToolCallId(String toolCallId) {
+            this.toolCallId = toolCallId;
+            return this;
+        }
+
+        public String getProgressMessage() {
+            return progressMessage;
+        }
+
+        public ToolExecutionProgressData setProgressMessage(String progressMessage) {
+            this.progressMessage = progressMessage;
+            return this;
+        }
+    }
+}

src/main/java/com/github/copilot/sdk/events/ToolExecutionProgressEvent.java

@@ -0,0 +1,92 @@
+/*---------------------------------------------------------------------------------------------
+ *  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;
+
+/**
+ * Response from the auth.getStatus RPC call.
+ * <p>
+ * Contains information about the current authentication status.
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class GetAuthStatusResponse {
+
+    /**
+     * Whether the user is authenticated.
+     */
+    @JsonProperty("isAuthenticated")
+    private boolean isAuthenticated;
+
+    /**
+     * Authentication type (user, env, gh-cli, hmac, api-key, token).
+     */
+    @JsonProperty("authType")
+    private String authType;
+
+    /**
+     * GitHub host URL.
+     */
+    @JsonProperty("host")
+    private String host;
+
+    /**
+     * User login name.
+     */
+    @JsonProperty("login")
+    private String login;
+
+    /**
+     * Human-readable status message.
+     */
+    @JsonProperty("statusMessage")
+    private String statusMessage;
+
+    public boolean isAuthenticated() {
+        return isAuthenticated;
+    }
+
+    public GetAuthStatusResponse setAuthenticated(boolean authenticated) {
+        isAuthenticated = authenticated;
+        return this;
+    }
+
+    public String getAuthType() {
+        return authType;
+    }
+
+    public GetAuthStatusResponse setAuthType(String authType) {
+        this.authType = authType;
+        return this;
+    }
+
+    public String getHost() {
+        return host;
+    }
+
+    public GetAuthStatusResponse setHost(String host) {
+        this.host = host;
+        return this;
+    }
+
+    public String getLogin() {
+        return login;
+    }
+
+    public GetAuthStatusResponse setLogin(String login) {
+        this.login = login;
+        return this;
+    }
+
+    public String getStatusMessage() {
+        return statusMessage;
+    }
+
+    public GetAuthStatusResponse setStatusMessage(String statusMessage) {
+        this.statusMessage = statusMessage;
+        return this;
+    }
+}

src/main/java/com/github/copilot/sdk/json/GetAuthStatusResponse.java

@@ -0,0 +1,31 @@
+/*---------------------------------------------------------------------------------------------
+ *  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;
+
+import java.util.List;
+
+/**
+ * Response from the models.list RPC call.
+ * <p>
+ * Contains a list of available models with their metadata.
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class GetModelsResponse {
+
+    @JsonProperty("models")
+    private List<ModelInfo> models;
+
+    public List<ModelInfo> getModels() {
+        return models;
+    }
+
+    public GetModelsResponse setModels(List<ModelInfo> models) {
+        this.models = models;
+        return this;
+    }
+}

src/main/java/com/github/copilot/sdk/json/GetModelsResponse.java

@@ -0,0 +1,47 @@
+/*---------------------------------------------------------------------------------------------
+ *  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;
+
+/**
+ * Response from the status.get RPC call.
+ * <p>
+ * Contains information about the CLI version and protocol version.
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class GetStatusResponse {
+
+    /**
+     * Package version (e.g., "1.0.0").
+     */
+    @JsonProperty("version")
+    private String version;
+
+    /**
+     * Protocol version for SDK compatibility.
+     */
+    @JsonProperty("protocolVersion")
+    private int protocolVersion;
+
+    public String getVersion() {
+        return version;
+    }
+
+    public GetStatusResponse setVersion(String version) {
+        this.version = version;
+        return this;
+    }
+
+    public int getProtocolVersion() {
+        return protocolVersion;
+    }
+
+    public GetStatusResponse setProtocolVersion(int protocolVersion) {
+        this.protocolVersion = protocolVersion;
+        return this;
+    }
+}