diff --git a/docs/troubleshooting/compatibility.md b/docs/troubleshooting/compatibility.md index c68d59cc7b..795c0f5fd4 100644 --- a/docs/troubleshooting/compatibility.md +++ b/docs/troubleshooting/compatibility.md @@ -84,6 +84,7 @@ The Copilot SDK communicates with the CLI via JSON-RPC protocol. Features must b | Config directory | `configDir` config | Override default config location | | Client name | `clientName` config | Identify app in User-Agent | | Working directory | `workingDirectory` config | Set session cwd | +| Additional directories | `additionalDirectories` config | Grant session access beyond the working directory; re-supply on resume | | **Experimental** | | | | Agent management | `session.rpc.agent.*` | List, select, deselect, get current agent | | Fleet mode | `session.rpc.fleet.start()` | Parallel sub-agent execution; see [Fleet mode](../features/fleet-mode.md) | diff --git a/dotnet/src/Client.cs b/dotnet/src/Client.cs index 9b50d6942d..b1199dac8a 100644 --- a/dotnet/src/Client.cs +++ b/dotnet/src/Client.cs @@ -1203,7 +1203,8 @@ public async Task CreateSessionAsync(SessionConfig config, Cance ExpAssignments: config.ExpAssignments, EnableManagedSettings: config.EnableManagedSettings, GitHubMcpToolConfig: config.GitHubMcpToolConfig, - EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null); + EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null, + AdditionalDirectories: config.AdditionalDirectories); var rpcTimestamp = Stopwatch.GetTimestamp(); @@ -1420,7 +1421,8 @@ public async Task ResumeSessionAsync(string sessionId, ResumeSes ExpAssignments: config.ExpAssignments, EnableManagedSettings: config.EnableManagedSettings, GitHubMcpToolConfig: config.GitHubMcpToolConfig, - EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null); + EnableGitHubTelemetryForwarding: _options.OnGitHubTelemetry != null ? true : null, + AdditionalDirectories: config.AdditionalDirectories); var rpcTimestamp = Stopwatch.GetTimestamp(); var response = await InvokeRpcAsync( @@ -2775,7 +2777,8 @@ internal record CreateSessionRequest( [property: JsonPropertyName("expAssignments")] CopilotExpAssignmentResponse? ExpAssignments = null, [property: JsonPropertyName("enableManagedSettings")] bool? EnableManagedSettings = null, bool? EnableGitHubTelemetryForwarding = null, - [property: JsonPropertyName("githubMcpToolConfig")] GitHubMcpToolConfig? GitHubMcpToolConfig = null); + [property: JsonPropertyName("githubMcpToolConfig")] GitHubMcpToolConfig? GitHubMcpToolConfig = null, + IList? AdditionalDirectories = null); #pragma warning restore GHCP001 internal record ToolDefinition( @@ -2884,7 +2887,8 @@ internal record ResumeSessionRequest( [property: JsonPropertyName("expAssignments")] CopilotExpAssignmentResponse? ExpAssignments = null, [property: JsonPropertyName("enableManagedSettings")] bool? EnableManagedSettings = null, bool? EnableGitHubTelemetryForwarding = null, - [property: JsonPropertyName("githubMcpToolConfig")] GitHubMcpToolConfig? GitHubMcpToolConfig = null); + [property: JsonPropertyName("githubMcpToolConfig")] GitHubMcpToolConfig? GitHubMcpToolConfig = null, + IList? AdditionalDirectories = null); #pragma warning restore GHCP001 internal record ResumeSessionResponse( diff --git a/dotnet/src/Types.cs b/dotnet/src/Types.cs index e0b3d19145..e1ba0355f5 100644 --- a/dotnet/src/Types.cs +++ b/dotnet/src/Types.cs @@ -3099,6 +3099,7 @@ protected SessionConfigBase(SessionConfigBase? other) SystemMessage = other.SystemMessage; Tools = other.Tools is not null ? [.. other.Tools] : null; WorkingDirectory = other.WorkingDirectory; + AdditionalDirectories = other.AdditionalDirectories is not null ? [.. other.AdditionalDirectories] : null; } /// Client name to identify the application using the SDK. @@ -3372,6 +3373,12 @@ protected SessionConfigBase(SessionConfigBase? other) /// Working directory for the session. public string? WorkingDirectory { get; set; } + /// + /// Additional directories the agent may access beyond . + /// Relative paths resolve against the session working directory. Re-supply them when resuming. + /// + public IList? AdditionalDirectories { get; set; } + /// /// Enable streaming of assistant message and reasoning chunks. /// When true, assistant.message_delta and assistant.reasoning_delta events diff --git a/dotnet/test/Unit/ClientSessionLifetimeTests.cs b/dotnet/test/Unit/ClientSessionLifetimeTests.cs index e1143db17c..a30e6d3030 100644 --- a/dotnet/test/Unit/ClientSessionLifetimeTests.cs +++ b/dotnet/test/Unit/ClientSessionLifetimeTests.cs @@ -255,6 +255,38 @@ public async Task CreateSessionAsync_Omits_CustomAgent_ReasoningEffort_When_Unse Assert.False(agent.TryGetProperty("reasoningEffort", out _)); } + [Fact] + public async Task SessionRequests_Serialize_AdditionalDirectories() + { + await using var server = await FakeCopilotServer.StartAsync(); + await using var client = new CopilotClient(new CopilotClientOptions { Connection = RuntimeConnection.ForUri(server.Url) }); + + await using var created = await client.CreateSessionAsync(new SessionConfig + { + AdditionalDirectories = ["/repo/shared", "/repo/generated"], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var createRequest = Assert.Single(server.Requests, request => request.Method == "session.create"); + Assert.Collection( + createRequest.Params.GetProperty("additionalDirectories").EnumerateArray(), + value => Assert.Equal("/repo/shared", value.GetString()), + value => Assert.Equal("/repo/generated", value.GetString())); + + server.ClearRequests(); + + await using var resumed = await client.ResumeSessionAsync("resume-with-additional-directories", new ResumeSessionConfig + { + AdditionalDirectories = ["/repo/resumed"], + OnPermissionRequest = PermissionHandler.ApproveAll + }); + + var resumeRequest = Assert.Single(server.Requests, request => request.Method == "session.resume"); + Assert.Collection( + resumeRequest.Params.GetProperty("additionalDirectories").EnumerateArray(), + value => Assert.Equal("/repo/resumed", value.GetString())); + } + [Fact] public async Task CreateSessionAsync_Registers_McpAuth_Interest_Only_When_Handler_Configured() { diff --git a/dotnet/test/Unit/CloneTests.cs b/dotnet/test/Unit/CloneTests.cs index e14003694d..ad8b0644e9 100644 --- a/dotnet/test/Unit/CloneTests.cs +++ b/dotnet/test/Unit/CloneTests.cs @@ -75,6 +75,7 @@ public void SessionConfig_Clone_CopiesAllProperties() ExcludedTools = ["tool3"], ExcludedBuiltInAgents = ["explore", "task"], WorkingDirectory = "/workspace", + AdditionalDirectories = ["/shared", "/generated"], Streaming = true, EnableCitations = true, EnableSessionTelemetry = false, @@ -120,6 +121,7 @@ public void SessionConfig_Clone_CopiesAllProperties() Assert.Equal(original.ExcludedTools, clone.ExcludedTools); Assert.Equal(original.ExcludedBuiltInAgents, clone.ExcludedBuiltInAgents); Assert.Equal(original.WorkingDirectory, clone.WorkingDirectory); + Assert.Equal(original.AdditionalDirectories, clone.AdditionalDirectories); Assert.Equal(original.Streaming, clone.Streaming); Assert.Equal(original.EnableCitations, clone.EnableCitations); Assert.Equal(original.EnableSessionTelemetry, clone.EnableSessionTelemetry); @@ -156,6 +158,7 @@ public void SessionConfig_Clone_CollectionsAreIndependent() ExcludedBuiltInAgents = ["explore"], McpServers = new Dictionary { ["s1"] = new McpStdioServerConfig { Command = "echo" } }, CustomAgents = [new CustomAgentConfig { Name = "a1" }], + AdditionalDirectories = ["/shared"], SkillDirectories = ["/skills"], InstructionDirectories = ["/instructions"], DisabledSkills = ["skill1"], @@ -169,6 +172,7 @@ public void SessionConfig_Clone_CollectionsAreIndependent() clone.ExcludedBuiltInAgents!.Add("task"); clone.McpServers!["s2"] = new McpStdioServerConfig { Command = "echo" }; clone.CustomAgents!.Add(new CustomAgentConfig { Name = "a2" }); + clone.AdditionalDirectories!.Add("/generated"); clone.SkillDirectories!.Add("/more"); clone.InstructionDirectories!.Add("/more-instructions"); clone.DisabledSkills!.Add("skill99"); @@ -179,6 +183,7 @@ public void SessionConfig_Clone_CollectionsAreIndependent() Assert.Single(original.ExcludedBuiltInAgents!); Assert.Single(original.McpServers!); Assert.Single(original.CustomAgents!); + Assert.Single(original.AdditionalDirectories!); Assert.Single(original.SkillDirectories!); Assert.Single(original.InstructionDirectories!); Assert.Single(original.DisabledSkills!); @@ -205,6 +210,7 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() ExcludedBuiltInAgents = ["explore"], McpServers = new Dictionary { ["s1"] = new McpStdioServerConfig { Command = "echo" } }, CustomAgents = [new CustomAgentConfig { Name = "a1" }], + AdditionalDirectories = ["/shared"], SkillDirectories = ["/skills"], InstructionDirectories = ["/instructions"], DisabledSkills = ["skill1"], @@ -218,6 +224,7 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() clone.ExcludedBuiltInAgents!.Add("task"); clone.McpServers!["s2"] = new McpStdioServerConfig { Command = "echo" }; clone.CustomAgents!.Add(new CustomAgentConfig { Name = "a2" }); + clone.AdditionalDirectories!.Add("/generated"); clone.SkillDirectories!.Add("/more"); clone.InstructionDirectories!.Add("/more-instructions"); clone.DisabledSkills!.Add("skill99"); @@ -228,6 +235,7 @@ public void ResumeSessionConfig_Clone_CollectionsAreIndependent() Assert.Single(original.ExcludedBuiltInAgents!); Assert.Single(original.McpServers!); Assert.Single(original.CustomAgents!); + Assert.Single(original.AdditionalDirectories!); Assert.Single(original.SkillDirectories!); Assert.Single(original.InstructionDirectories!); Assert.Single(original.DisabledSkills!); diff --git a/go/client.go b/go/client.go index 34f6d574a4..f867b7db28 100644 --- a/go/client.go +++ b/go/client.go @@ -803,6 +803,7 @@ func (c *Client) CreateSession(ctx context.Context, config *SessionConfig) (*Ses req.ManageScheduleEnabled = config.ManageScheduleEnabled req.ModelCapabilities = config.ModelCapabilities req.WorkingDirectory = config.WorkingDirectory + req.AdditionalDirectories = config.AdditionalDirectories req.MCPServers = config.MCPServers req.MCPOAuthTokenStorage = config.MCPOAuthTokenStorage req.EnvValueMode = "direct" @@ -1165,6 +1166,7 @@ func (c *Client) ResumeSessionWithOptions(ctx context.Context, sessionID string, req.Hooks = Bool(true) } req.WorkingDirectory = config.WorkingDirectory + req.AdditionalDirectories = config.AdditionalDirectories req.ConfigDir = config.ConfigDirectory req.EnableConfigDiscovery = config.EnableConfigDiscovery req.SkipEmbeddingRetrieval = config.SkipEmbeddingRetrieval diff --git a/go/client_test.go b/go/client_test.go index 2a6db6e861..14131bc4ce 100644 --- a/go/client_test.go +++ b/go/client_test.go @@ -251,6 +251,60 @@ func TestClient_ForwardsCapiOptionsToSessionRequests(t *testing.T) { assertCapiEnableWebSocketResponses(t, <-resumeParams) } +func TestClient_ForwardsAdditionalDirectoriesToSessionRequests(t *testing.T) { + rpcClient, server, _ := newRuntimeShutdownRpcPair(t) + t.Cleanup(server.Stop) + client := &Client{ + client: rpcClient, + RPC: rpc.NewServerRPC(rpcClient), + sessions: make(map[string]*Session), + } + + createParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.create", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + createParams <- append(json.RawMessage(nil), params...) + sessionID := sessionIDFromParams(t, params) + return []byte(`{"sessionId":"` + sessionID + `","workspacePath":"/workspace"}`), nil + }) + + _, err := client.CreateSession(t.Context(), &SessionConfig{ + AdditionalDirectories: []string{"/repo/shared", "/repo/generated"}, + }) + if err != nil { + t.Fatalf("CreateSession failed: %v", err) + } + assertAdditionalDirectories(t, <-createParams, []string{"/repo/shared", "/repo/generated"}) + + resumeParams := make(chan json.RawMessage, 1) + server.SetRequestHandler("session.resume", func(params json.RawMessage) (json.RawMessage, *jsonrpc2.Error) { + resumeParams <- append(json.RawMessage(nil), params...) + return []byte(`{"sessionId":"resumed-additional-directories","workspacePath":"/workspace"}`), nil + }) + + _, err = client.ResumeSessionWithOptions( + t.Context(), + "resumed-additional-directories", + &ResumeSessionConfig{AdditionalDirectories: []string{"/repo/resumed"}}, + ) + if err != nil { + t.Fatalf("ResumeSessionWithOptions failed: %v", err) + } + assertAdditionalDirectories(t, <-resumeParams, []string{"/repo/resumed"}) +} + +func assertAdditionalDirectories(t *testing.T, params json.RawMessage, want []string) { + t.Helper() + var payload struct { + AdditionalDirectories []string `json:"additionalDirectories"` + } + if err := json.Unmarshal(params, &payload); err != nil { + t.Fatalf("failed to decode request params: %v", err) + } + if !reflect.DeepEqual(payload.AdditionalDirectories, want) { + t.Fatalf("additionalDirectories = %v, want %v", payload.AdditionalDirectories, want) + } +} + func TestClient_ForwardsCanvasProviderToSessionRequests(t *testing.T) { rpcClient, server, _ := newRuntimeShutdownRpcPair(t) t.Cleanup(server.Stop) diff --git a/go/types.go b/go/types.go index 9b3b53455f..3ddcf930dc 100644 --- a/go/types.go +++ b/go/types.go @@ -1242,6 +1242,9 @@ type SessionConfig struct { // WorkingDirectory is the working directory for the session. // Tool operations will be relative to this directory. WorkingDirectory string + // AdditionalDirectories are directories the agent may access beyond WorkingDirectory. + // Relative paths are resolved against WorkingDirectory. Re-supply them when resuming. + AdditionalDirectories []string // Streaming enables streaming of assistant message and reasoning chunks. // When non-nil and true, assistant.message_delta and assistant.reasoning_delta // events with deltaContent are sent as the response is generated. @@ -1740,6 +1743,9 @@ type ResumeSessionConfig struct { // WorkingDirectory is the working directory for the session. // Tool operations will be relative to this directory. WorkingDirectory string + // AdditionalDirectories are directories the agent may access beyond WorkingDirectory. + // Relative paths are resolved against WorkingDirectory. Re-supply them when resuming. + AdditionalDirectories []string // ConfigDirectory overrides the default configuration directory location. ConfigDirectory string // EnableConfigDiscovery enables runtime discovery of supported configuration. @@ -2319,6 +2325,7 @@ type createSessionRequest struct { RequestAutoModeSwitch *bool `json:"requestAutoModeSwitch,omitempty"` Hooks *bool `json:"hooks,omitempty"` WorkingDirectory string `json:"workingDirectory,omitempty"` + AdditionalDirectories []string `json:"additionalDirectories,omitempty"` Streaming *bool `json:"streaming,omitempty"` IncludeSubAgentStreamingEvents *bool `json:"includeSubAgentStreamingEvents,omitempty"` EnableGitHubTelemetryForwarding *bool `json:"enableGitHubTelemetryForwarding,omitempty"` @@ -2411,6 +2418,7 @@ type resumeSessionRequest struct { RequestAutoModeSwitch *bool `json:"requestAutoModeSwitch,omitempty"` Hooks *bool `json:"hooks,omitempty"` WorkingDirectory string `json:"workingDirectory,omitempty"` + AdditionalDirectories []string `json:"additionalDirectories,omitempty"` ConfigDir string `json:"configDir,omitempty"` EnableConfigDiscovery *bool `json:"enableConfigDiscovery,omitempty"` SkipEmbeddingRetrieval *bool `json:"skipEmbeddingRetrieval,omitempty"` diff --git a/java/src/main/java/com/github/copilot/SessionRequestBuilder.java b/java/src/main/java/com/github/copilot/SessionRequestBuilder.java index 593e881c1d..62c7120252 100644 --- a/java/src/main/java/com/github/copilot/SessionRequestBuilder.java +++ b/java/src/main/java/com/github/copilot/SessionRequestBuilder.java @@ -140,6 +140,7 @@ static CreateSessionRequest buildCreateRequest(SessionConfig config, String sess request.setHooks(true); } request.setWorkingDirectory(config.getWorkingDirectory()); + request.setAdditionalDirectories(config.getAdditionalDirectories()); if (config.isStreaming()) { request.setStreaming(true); } @@ -272,6 +273,7 @@ static ResumeSessionRequest buildResumeRequest(String sessionId, ResumeSessionCo request.setHooks(true); } request.setWorkingDirectory(config.getWorkingDirectory()); + request.setAdditionalDirectories(config.getAdditionalDirectories()); request.setConfigDirectory(config.getConfigDirectory()); config.getEnableConfigDiscovery().ifPresent(request::setEnableConfigDiscovery); config.getSkipEmbeddingRetrieval().ifPresent(request::setSkipEmbeddingRetrieval); diff --git a/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java b/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java index 682d6fb7cf..44cb8145c3 100644 --- a/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java +++ b/java/src/main/java/com/github/copilot/rpc/CreateSessionRequest.java @@ -95,6 +95,9 @@ public final class CreateSessionRequest { @JsonProperty("workingDirectory") private String workingDirectory; + @JsonProperty("additionalDirectories") + private List additionalDirectories; + @JsonProperty("streaming") private Boolean streaming; @@ -502,6 +505,21 @@ public void setWorkingDirectory(String workingDirectory) { this.workingDirectory = workingDirectory; } + /** Gets additional directories. @return the additional directories */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets additional directories. + * + * @param additionalDirectories + * the additional directories + */ + public void setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + } + /** Gets streaming flag. @return the flag */ public Boolean getStreaming() { return streaming; diff --git a/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java b/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java index 373f5e8120..35072f1290 100644 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java +++ b/java/src/main/java/com/github/copilot/rpc/ResumeSessionConfig.java @@ -68,6 +68,7 @@ public class ResumeSessionConfig { private UserInputHandler onUserInputRequest; private SessionHooks hooks; private String workingDirectory; + private List additionalDirectories; private String configDirectory; private Boolean enableConfigDiscovery; private Boolean skipEmbeddingRetrieval; @@ -859,6 +860,27 @@ public ResumeSessionConfig setWorkingDirectory(String workingDirectory) { return this; } + /** + * Gets the directories the agent may access beyond the working directory. + * + * @return the additional directory paths + */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets directories the agent may access beyond the working directory. + * + * @param additionalDirectories + * the additional directory paths + * @return this config for method chaining + */ + public ResumeSessionConfig setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + return this; + } + /** * Gets the configuration directory path. * @@ -1902,6 +1924,9 @@ public ResumeSessionConfig clone() { copy.onUserInputRequest = this.onUserInputRequest; copy.hooks = this.hooks; copy.workingDirectory = this.workingDirectory; + copy.additionalDirectories = this.additionalDirectories != null + ? new ArrayList<>(this.additionalDirectories) + : null; copy.configDirectory = this.configDirectory; copy.enableConfigDiscovery = this.enableConfigDiscovery; copy.skipEmbeddingRetrieval = this.skipEmbeddingRetrieval; diff --git a/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java b/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java index c3559d7b2d..a0ecc2ed5c 100644 --- a/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java +++ b/java/src/main/java/com/github/copilot/rpc/ResumeSessionRequest.java @@ -97,6 +97,9 @@ public final class ResumeSessionRequest { @JsonProperty("workingDirectory") private String workingDirectory; + @JsonProperty("additionalDirectories") + private List additionalDirectories; + @JsonProperty("configDir") private String configDirectory; @@ -507,6 +510,21 @@ public void setWorkingDirectory(String workingDirectory) { this.workingDirectory = workingDirectory; } + /** Gets additional directories. @return the additional directories */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets additional directories. + * + * @param additionalDirectories + * the additional directories + */ + public void setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + } + /** Gets config directory. @return the config directory */ public String getConfigDirectory() { return configDirectory; diff --git a/java/src/main/java/com/github/copilot/rpc/SessionConfig.java b/java/src/main/java/com/github/copilot/rpc/SessionConfig.java index 827a00df69..c062b1c7c6 100644 --- a/java/src/main/java/com/github/copilot/rpc/SessionConfig.java +++ b/java/src/main/java/com/github/copilot/rpc/SessionConfig.java @@ -68,6 +68,7 @@ public class SessionConfig { private UserInputHandler onUserInputRequest; private SessionHooks hooks; private String workingDirectory; + private List additionalDirectories; private boolean streaming; private Boolean includeSubAgentStreamingEvents; private Map mcpServers; @@ -909,6 +910,27 @@ public SessionConfig setWorkingDirectory(String workingDirectory) { return this; } + /** + * Gets the directories the agent may access beyond the working directory. + * + * @return the additional directory paths + */ + public List getAdditionalDirectories() { + return additionalDirectories; + } + + /** + * Sets directories the agent may access beyond the working directory. + * + * @param additionalDirectories + * the additional directory paths + * @return this config instance for method chaining + */ + public SessionConfig setAdditionalDirectories(List additionalDirectories) { + this.additionalDirectories = additionalDirectories; + return this; + } + /** * Returns whether streaming is enabled. * @@ -2037,6 +2059,9 @@ public SessionConfig clone() { copy.onUserInputRequest = this.onUserInputRequest; copy.hooks = this.hooks; copy.workingDirectory = this.workingDirectory; + copy.additionalDirectories = this.additionalDirectories != null + ? new ArrayList<>(this.additionalDirectories) + : null; copy.streaming = this.streaming; copy.includeSubAgentStreamingEvents = this.includeSubAgentStreamingEvents; copy.mcpServers = this.mcpServers != null ? new java.util.HashMap<>(this.mcpServers) : null; diff --git a/java/src/test/java/com/github/copilot/ConfigCloneTest.java b/java/src/test/java/com/github/copilot/ConfigCloneTest.java index 6986ef7f0e..a8e7fb2e0b 100644 --- a/java/src/test/java/com/github/copilot/ConfigCloneTest.java +++ b/java/src/test/java/com/github/copilot/ConfigCloneTest.java @@ -440,12 +440,15 @@ void resumeSessionConfigAllSetters() { void sessionConfigNewFieldsCloned() { SessionConfig original = new SessionConfig(); original.setGitHubToken("ghp_per_session_token"); + original.setAdditionalDirectories(new java.util.ArrayList<>(List.of("/repo/shared"))); DefaultAgentConfig defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); original.setDefaultAgent(defaultAgent); SessionConfig cloned = original.clone(); assertEquals("ghp_per_session_token", cloned.getGitHubToken()); + assertEquals(List.of("/repo/shared"), cloned.getAdditionalDirectories()); + assertNotSame(original.getAdditionalDirectories(), cloned.getAdditionalDirectories()); assertSame(defaultAgent, cloned.getDefaultAgent()); } @@ -453,12 +456,15 @@ void sessionConfigNewFieldsCloned() { void resumeSessionConfigNewFieldsCloned() { ResumeSessionConfig original = new ResumeSessionConfig(); original.setGitHubToken("ghp_per_session_token"); + original.setAdditionalDirectories(new java.util.ArrayList<>(List.of("/repo/resumed"))); DefaultAgentConfig defaultAgent = new DefaultAgentConfig().setExcludedTools(List.of("secret_tool")); original.setDefaultAgent(defaultAgent); ResumeSessionConfig cloned = original.clone(); assertEquals("ghp_per_session_token", cloned.getGitHubToken()); + assertEquals(List.of("/repo/resumed"), cloned.getAdditionalDirectories()); + assertNotSame(original.getAdditionalDirectories(), cloned.getAdditionalDirectories()); assertSame(defaultAgent, cloned.getDefaultAgent()); } diff --git a/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java b/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java index 397ed607a0..54773662c5 100644 --- a/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java +++ b/java/src/test/java/com/github/copilot/SessionRequestBuilderTest.java @@ -127,6 +127,13 @@ void testBuildCreateRequestSetsClientName() { assertEquals("my-app", request.getClientName()); } + @Test + void testBuildCreateRequestSetsAdditionalDirectories() { + var config = new SessionConfig().setAdditionalDirectories(List.of("/repo/shared", "/repo/generated")); + CreateSessionRequest request = SessionRequestBuilder.buildCreateRequest(config); + assertEquals(List.of("/repo/shared", "/repo/generated"), request.getAdditionalDirectories()); + } + @Test void testBuildCreateRequestSetsReasoningSummary() { var config = new SessionConfig().setReasoningSummary("concise"); @@ -362,6 +369,13 @@ void testBuildResumeRequestSetsClientName() { assertEquals("my-app", request.getClientName()); } + @Test + void testBuildResumeRequestSetsAdditionalDirectories() { + var config = new ResumeSessionConfig().setAdditionalDirectories(List.of("/repo/resumed")); + ResumeSessionRequest request = SessionRequestBuilder.buildResumeRequest("sid-additional-directories", config); + assertEquals(List.of("/repo/resumed"), request.getAdditionalDirectories()); + } + @Test void testBuildCreateRequestPropagatesGranularMultitenancyFields() { var config = new SessionConfig().setSkipEmbeddingRetrieval(true) diff --git a/nodejs/src/client.ts b/nodejs/src/client.ts index c0cb6ed17e..3e100edddd 100644 --- a/nodejs/src/client.ts +++ b/nodejs/src/client.ts @@ -1572,6 +1572,7 @@ export class CopilotClient { requestAutoModeSwitch: !!config.onAutoModeSwitchRequest, hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)), workingDirectory: config.workingDirectory, + additionalDirectories: config.additionalDirectories, streaming: config.streaming, includeSubAgentStreamingEvents: config.includeSubAgentStreamingEvents ?? true, ...(this.onGitHubTelemetry != null @@ -1814,6 +1815,7 @@ export class CopilotClient { requestAutoModeSwitch: !!config.onAutoModeSwitchRequest, hooks: !!(config.hooks && Object.values(config.hooks).some(Boolean)), workingDirectory: config.workingDirectory, + additionalDirectories: config.additionalDirectories, configDir: config.configDirectory, enableConfigDiscovery: config.enableConfigDiscovery, skipEmbeddingRetrieval: config.skipEmbeddingRetrieval, diff --git a/nodejs/src/types.ts b/nodejs/src/types.ts index b677808eca..a8a9410f84 100644 --- a/nodejs/src/types.ts +++ b/nodejs/src/types.ts @@ -2411,6 +2411,13 @@ export interface SessionConfigBase { */ workingDirectory?: string; + /** + * Additional directories the agent may access beyond the working directory. + * Relative paths are resolved against the session's working directory. + * Re-supply these directories when resuming a session. + */ + additionalDirectories?: string[]; + /** * Enable streaming of assistant message and reasoning chunks. * When true, ephemeral assistant.message_delta and assistant.reasoning_delta diff --git a/nodejs/test/client.test.ts b/nodejs/test/client.test.ts index 78fbe0426c..bbe6fbe666 100644 --- a/nodejs/test/client.test.ts +++ b/nodejs/test/client.test.ts @@ -270,6 +270,42 @@ describe("CopilotClient", () => { ); }); + it("forwards additional directories when creating and resuming sessions", async () => { + const client = new CopilotClient(); + await client.start(); + onTestFinished(() => stopClient(client)); + + const spy = vi + .spyOn((client as any).connection!, "sendRequest") + .mockImplementation(async (method: string, params: any) => { + if (method === "session.create" || method === "session.resume") { + return { sessionId: params.sessionId, workspacePath: "/workspace" }; + } + throw new Error(`Unexpected method: ${method}`); + }); + + await client.createSession({ + sessionId: "create-with-additional-directories", + additionalDirectories: ["/repo/shared", "/repo/generated"], + onPermissionRequest: approveAll, + }); + await client.resumeSession("resume-with-additional-directories", { + additionalDirectories: ["/repo/resumed"], + onPermissionRequest: approveAll, + }); + + expect(spy).toHaveBeenCalledWith( + "session.create", + expect.objectContaining({ + additionalDirectories: ["/repo/shared", "/repo/generated"], + }) + ); + expect(spy).toHaveBeenCalledWith( + "session.resume", + expect.objectContaining({ additionalDirectories: ["/repo/resumed"] }) + ); + }); + it("registers MCP OAuth interest after cloud create only when an auth handler is configured", async () => { const client = new CopilotClient(); await client.start(); diff --git a/python/copilot/client.py b/python/copilot/client.py index 8f7c2daf0a..737619ef35 100644 --- a/python/copilot/client.py +++ b/python/copilot/client.py @@ -2030,6 +2030,7 @@ async def create_session( on_user_input_request: UserInputHandler | None = None, hooks: SessionHooks | None = None, working_directory: str | None = None, + additional_directories: list[str] | None = None, provider: ProviderConfig | None = None, capi: CapiSessionOptions | None = None, providers: list[NamedProviderConfig] | None = None, @@ -2384,6 +2385,8 @@ async def create_session( # Add working directory if provided if working_directory: payload["workingDirectory"] = working_directory + if additional_directories: + payload["additionalDirectories"] = additional_directories # Add streaming option if provided if streaming is not None: @@ -2726,6 +2729,7 @@ async def resume_session( on_user_input_request: UserInputHandler | None = None, hooks: SessionHooks | None = None, working_directory: str | None = None, + additional_directories: list[str] | None = None, provider: ProviderConfig | None = None, capi: CapiSessionOptions | None = None, providers: list[NamedProviderConfig] | None = None, @@ -3104,6 +3108,8 @@ async def resume_session( if working_directory: payload["workingDirectory"] = working_directory + if additional_directories: + payload["additionalDirectories"] = additional_directories if config_directory: payload["configDir"] = config_directory if enable_config_discovery is not None: diff --git a/python/test_client.py b/python/test_client.py index 0f3ba8136e..0bba1ccd7f 100644 --- a/python/test_client.py +++ b/python/test_client.py @@ -163,6 +163,46 @@ async def test_resume_session_allows_none_permission_handler(self): class TestCreateSessionConfig: + @pytest.mark.asyncio + async def test_additional_directories_forwarded_on_create_and_resume(self): + client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) + await client.start() + try: + captured: list[tuple[str, dict]] = [] + + async def mock_request(method, params, **kwargs): + captured.append((method, params)) + if method == "session.create": + result = {"sessionId": params["sessionId"], "workspacePath": None} + callback = kwargs.get("on_response_inline") + if callback is not None: + callback(result) + return result + if method == "session.resume": + return {"sessionId": params["sessionId"], "workspacePath": None} + return {} + + client._client.request = mock_request + await client.create_session( + session_id="create-with-additional-directories", + additional_directories=["/repo/shared", "/repo/generated"], + ) + await client.resume_session( + "resume-with-additional-directories", + additional_directories=["/repo/resumed"], + ) + + create_payload = next( + params for method, params in captured if method == "session.create" + ) + resume_payload = next( + params for method, params in captured if method == "session.resume" + ) + assert create_payload["additionalDirectories"] == ["/repo/shared", "/repo/generated"] + assert resume_payload["additionalDirectories"] == ["/repo/resumed"] + finally: + await client.force_stop() + @pytest.mark.asyncio async def test_mcp_auth_handler_registers_interest_in_create_session(self): client = CopilotClient(connection=RuntimeConnection.for_stdio(path=CLI_PATH)) diff --git a/rust/src/types.rs b/rust/src/types.rs index 1c5e457a36..d2b8dcb93a 100644 --- a/rust/src/types.rs +++ b/rust/src/types.rs @@ -1990,6 +1990,10 @@ pub struct SessionConfig { /// Working directory for the session. Tool operations resolve /// relative paths against this directory. pub working_directory: Option, + /// Additional directories the agent may access beyond the working directory. + /// Relative paths resolve against the session working directory. Re-supply + /// them when resuming a session. + pub additional_directories: Option>, /// Per-session GitHub token. Distinct from /// [`ClientOptions::github_token`](crate::ClientOptions::github_token), /// which authenticates the CLI process itself; this token determines @@ -2158,6 +2162,7 @@ impl std::fmt::Debug for SessionConfig { .field("memory", &self.memory) .field("config_directory", &self.config_directory) .field("working_directory", &self.working_directory) + .field("additional_directories", &self.additional_directories) .field( "github_token", &self.github_token.as_ref().map(|_| ""), @@ -2274,6 +2279,7 @@ impl Default for SessionConfig { memory: None, config_directory: None, working_directory: None, + additional_directories: None, github_token: None, remote_session: None, cloud: None, @@ -2435,6 +2441,7 @@ impl SessionConfig { memory: self.memory, config_dir: self.config_directory, working_directory: self.working_directory, + additional_directories: self.additional_directories, github_token: self.github_token, remote_session: self.remote_session, cloud: self.cloud, @@ -2964,6 +2971,16 @@ impl SessionConfig { self } + /// Set directories the agent may access beyond the working directory. + pub fn with_additional_directories(mut self, paths: I) -> Self + where + I: IntoIterator, + P: Into, + { + self.additional_directories = Some(paths.into_iter().map(Into::into).collect()); + self + } + /// Set the per-session GitHub token. Distinct from /// [`ClientOptions::github_token`](crate::ClientOptions::github_token); /// this token determines the GitHub identity used for content exclusion, @@ -3209,6 +3226,9 @@ pub struct ResumeSessionConfig { pub config_directory: Option, /// Per-session working directory on resume. pub working_directory: Option, + /// Additional directories the agent may access on resume. Relative paths + /// resolve against the session working directory. + pub additional_directories: Option>, /// Per-session GitHub token on resume. See /// [`SessionConfig::github_token`]. pub github_token: Option, @@ -3357,6 +3377,7 @@ impl std::fmt::Debug for ResumeSessionConfig { .field("memory", &self.memory) .field("config_directory", &self.config_directory) .field("working_directory", &self.working_directory) + .field("additional_directories", &self.additional_directories) .field( "github_token", &self.github_token.as_ref().map(|_| ""), @@ -3517,6 +3538,7 @@ impl ResumeSessionConfig { memory: self.memory, config_dir: self.config_directory, working_directory: self.working_directory, + additional_directories: self.additional_directories, github_token: self.github_token, remote_session: self.remote_session, include_sub_agent_streaming_events: self.include_sub_agent_streaming_events, @@ -3610,6 +3632,7 @@ impl ResumeSessionConfig { memory: None, config_directory: None, working_directory: None, + additional_directories: None, github_token: None, remote_session: None, include_sub_agent_streaming_events: None, @@ -4115,6 +4138,16 @@ impl ResumeSessionConfig { self } + /// Set directories the agent may access beyond the working directory on resume. + pub fn with_additional_directories(mut self, paths: I) -> Self + where + I: IntoIterator, + P: Into, + { + self.additional_directories = Some(paths.into_iter().map(Into::into).collect()); + self + } + /// Set the per-session GitHub token on resume. See /// [`SessionConfig::github_token`] for distinction from the /// client-level token. @@ -6427,6 +6460,7 @@ mod tests { .with_agent("researcher") .with_config_directory(PathBuf::from("/tmp/config")) .with_working_directory(PathBuf::from("/tmp/work")) + .with_additional_directories([PathBuf::from("/tmp/shared")]) .with_github_token("ghp_test") .with_capi(CapiSessionOptions::new().with_enable_web_socket_responses(false)) .with_enable_session_telemetry(false) @@ -6464,6 +6498,10 @@ mod tests { assert_eq!(cfg.agent.as_deref(), Some("researcher")); assert_eq!(cfg.config_directory, Some(PathBuf::from("/tmp/config"))); assert_eq!(cfg.working_directory, Some(PathBuf::from("/tmp/work"))); + assert_eq!( + cfg.additional_directories.as_deref(), + Some(&[PathBuf::from("/tmp/shared")][..]) + ); assert_eq!(cfg.github_token.as_deref(), Some("ghp_test")); assert_eq!( cfg.capi, @@ -6498,6 +6536,7 @@ mod tests { .with_agent("researcher") .with_config_directory(PathBuf::from("/tmp/config")) .with_working_directory(PathBuf::from("/tmp/work")) + .with_additional_directories([PathBuf::from("/tmp/shared")]) .with_github_token("ghp_test") .with_capi(CapiSessionOptions::new().with_enable_web_socket_responses(false)) .with_enable_session_telemetry(false) @@ -6535,6 +6574,10 @@ mod tests { assert_eq!(cfg.agent.as_deref(), Some("researcher")); assert_eq!(cfg.config_directory, Some(PathBuf::from("/tmp/config"))); assert_eq!(cfg.working_directory, Some(PathBuf::from("/tmp/work"))); + assert_eq!( + cfg.additional_directories.as_deref(), + Some(&[PathBuf::from("/tmp/shared")][..]) + ); assert_eq!(cfg.github_token.as_deref(), Some("ghp_test")); assert_eq!( cfg.capi, @@ -6569,6 +6612,29 @@ mod tests { assert!(json.get("continuePendingWork").is_none()); } + #[test] + fn session_configs_serialize_additional_directories() { + let create = SessionConfig::default().with_additional_directories([ + PathBuf::from("/tmp/shared"), + PathBuf::from("/tmp/generated"), + ]); + let (create_wire, _) = create.into_wire(None).expect("no duplicate handlers"); + let create_json = serde_json::to_value(&create_wire).unwrap(); + assert_eq!( + create_json["additionalDirectories"], + serde_json::json!(["/tmp/shared", "/tmp/generated"]) + ); + + let resume = ResumeSessionConfig::new(SessionId::from("sess-1")) + .with_additional_directories([PathBuf::from("/tmp/resumed")]); + let (resume_wire, _) = resume.into_wire().expect("no duplicate handlers"); + let resume_json = serde_json::to_value(&resume_wire).unwrap(); + assert_eq!( + resume_json["additionalDirectories"], + serde_json::json!(["/tmp/resumed"]) + ); + } + /// The Rust field is `suppress_resume_event`, but the wire field stays /// `disableResume` to preserve compatibility with the runtime and other /// SDKs. diff --git a/rust/src/wire.rs b/rust/src/wire.rs index 1620e5ee1a..261350e972 100644 --- a/rust/src/wire.rs +++ b/rust/src/wire.rs @@ -161,6 +161,8 @@ pub(crate) struct SessionCreateWire { pub config_dir: Option, #[serde(skip_serializing_if = "Option::is_none")] pub working_directory: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_directories: Option>, #[serde(rename = "gitHubToken", skip_serializing_if = "Option::is_none")] pub github_token: Option, #[serde(skip_serializing_if = "Option::is_none")] @@ -303,6 +305,8 @@ pub(crate) struct SessionResumeWire { pub config_dir: Option, #[serde(skip_serializing_if = "Option::is_none")] pub working_directory: Option, + #[serde(skip_serializing_if = "Option::is_none")] + pub additional_directories: Option>, #[serde(rename = "gitHubToken", skip_serializing_if = "Option::is_none")] pub github_token: Option, #[serde(skip_serializing_if = "Option::is_none")] diff --git a/rust/tests/e2e/support.rs b/rust/tests/e2e/support.rs index 6ad609f58e..4d9de5536b 100644 --- a/rust/tests/e2e/support.rs +++ b/rust/tests/e2e/support.rs @@ -330,6 +330,9 @@ impl E2eContext { .as_os_str() .to_owned(), ), + ]); + env.extend(isolated_cache_environment(self.home_dir.path())); + env.extend([ ("COPILOT_MCP_APPS".into(), "true".into()), ("MCP_APPS".into(), "true".into()), ("GH_TOKEN".into(), DEFAULT_TEST_TOKEN.into()), @@ -783,6 +786,20 @@ fn canonical_temp_path(path: &Path) -> PathBuf { std::fs::canonicalize(path).unwrap_or_else(|_| path.to_path_buf()) } +fn isolated_cache_environment(path: &Path) -> [(OsString, OsString); 2] { + let home_dir = canonical_temp_path(path); + let cache_dir = home_dir.join(".cache"); + // COPILOT_HOME does not redirect platform cache paths, so isolate the cache + // to prevent concurrent CLI processes from sharing mutable startup state. + [ + ( + "COPILOT_CACHE_HOME".into(), + cache_dir.join("copilot").into_os_string(), + ), + ("XDG_CACHE_HOME".into(), cache_dir.into_os_string()), + ] +} + struct CapiProxy { child: Option, proxy_url: String, @@ -1003,3 +1020,25 @@ fn node_program() -> &'static str { fn npx_program() -> &'static str { if cfg!(windows) { "npx.cmd" } else { "npx" } } + +#[test] +fn e2e_context_isolates_copilot_cache() { + let home_dir = tempfile::tempdir().expect("create test home"); + let home_dir = canonical_temp_path(home_dir.path()); + let cache_dir = home_dir.join(".cache"); + let expected = [ + ("COPILOT_CACHE_HOME", cache_dir.join("copilot")), + ("XDG_CACHE_HOME", cache_dir), + ]; + + let environment = isolated_cache_environment(&home_dir); + + for (key, value) in expected { + assert!( + environment.iter().any(|(actual_key, actual_value)| { + actual_key == key && actual_value == value.as_os_str() + }), + "{key} should use the isolated test home" + ); + } +}