Skip to content

Multitenancy hardening: Client Mode#1428

Merged
SteveSandersonMS merged 17 commits into
mainfrom
stevesandersonms/session-profiles
May 27, 2026
Merged

Multitenancy hardening: Client Mode#1428
SteveSandersonMS merged 17 commits into
mainfrom
stevesandersonms/session-profiles

Conversation

@SteveSandersonMS
Copy link
Copy Markdown
Contributor

@SteveSandersonMS SteveSandersonMS commented May 26, 2026

Why

By default, CopilotClient gives every session the full Copilot CLI experience: every built-in tool, every host-side capability, user files like AGENTS.md / co-author trailers / plugins / custom agents, and a system prompt full of environment context.

That is great for an IDE plugin, but unsafe for a multi-tenant app where each session may belong to a different end user. There is no single switch to opt out of the host integration and start from a clean slate.

What

Add CopilotClientMode.Empty (TS mode: "empty"). When set, the SDK flips the host-integration defaults to safe values and requires every session to declare its tool surface up front via availableTools. The runtime stays mode-agnostic; this is a thin SDK-side translation.

Empty mode contract

  • Tool surface defaults to empty. availableTools is required on every session; pass a ToolSet (or string[]). excludedTools composes with it via deny-precedence so callers can write "everything matching X except Y".
  • Host integration disabled: per-user installed plugins, custom instructions, custom agents on disk, the co-author trailer, the manage-schedule tool, and session telemetry are all forced off (caller-supplied values still win).
  • System prompt sanitized: the environment_context section (working directory, OS, etc.) is stripped unless the caller explicitly opts in.
  • System keychain integration is disabled
  • Storage is required: baseDirectory (or sessionFs) must be set so session data doesn't leak into ~/.copilot by mistake

TypeScript

const client = new CopilotClient({
    mode: "empty",
    baseDirectory: "/tmp/per-tenant-state",
});

const session = await client.createSession({
    onPermissionRequest: approveAll,
    availableTools: new ToolSet()
        .addBuiltIn(BuiltInTools.Isolated)
        .addMcp("*"),
    excludedTools: new ToolSet()
        .addMcp("github-delete_repository"),
});

C#

using var client = new CopilotClient(new CopilotClientOptions
{
    Mode = CopilotClientMode.Empty,
    BaseDirectory = "/tmp/per-tenant-state",
});

await using var session = await client.CreateSessionAsync(new SessionConfig
{
    OnPermissionRequest = PermissionHandler.ApproveAll,
    AvailableTools = new ToolSet()
        .AddBuiltIn(BuiltInTools.Isolated)
        .AddMcp("*"),
    ExcludedTools = new ToolSet()
        .AddMcp("github-delete_repository"),
});

Coverage

TypeScript, Python, Go, C#, and Rust SDKs. Mirrored E2E tests across all five SDKs (shared cassettes under test/snapshots/mode_empty/) verify the SDK translation reaches the runtime correctly: the tool list the LLM sees, the stripped system message, and end-to-end behavior on representative prompts.

Remaining work

This PR establishes the pattern for setting empty mode, but doesn't implement all the runtime flags for disabling all the things we want to disable in that mode. The remaining parts are tracked in different issue that @MackinnonBuck is handling.

@SteveSandersonMS SteveSandersonMS changed the title Multitenancy hardening: Session profiles via Mode=empty (Node SDK) Multitenancy hardening: Client Mode May 26, 2026
@github-actions

This comment has been minimized.

@SteveSandersonMS SteveSandersonMS force-pushed the stevesandersonms/session-profiles branch from 7ee91d6 to a41b260 Compare May 27, 2026 12:03
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@SteveSandersonMS SteveSandersonMS force-pushed the stevesandersonms/session-profiles branch from 159647a to 7a4f8b5 Compare May 27, 2026 12:55
@github-actions

This comment has been minimized.

@SteveSandersonMS SteveSandersonMS force-pushed the stevesandersonms/session-profiles branch from 9bf763f to d58befa Compare May 27, 2026 13:05
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Comment thread dotnet/src/Client.cs
Comment on lines +528 to +538
foreach (var entry in list)
{
if (entry == "*")
{
throw new ArgumentException(
$"Invalid {field} entry '*': there is no bare wildcard. " +
"Use `new ToolSet().AddBuiltIn(\"*\")`, `.AddMcp(\"*\")`, or " +
"`.AddCustom(\"*\")` to target a specific source.",
nameof(list));
}
}
Comment thread dotnet/test/E2E/ModeEmptyE2ETests.cs Fixed
Comment thread dotnet/test/E2E/ModeEmptyE2ETests.cs Fixed
Comment thread dotnet/test/E2E/ModeEmptyE2ETests.cs Fixed
Comment thread dotnet/test/E2E/ModeEmptyE2ETests.cs Fixed
Comment thread dotnet/test/E2E/ModeEmptyE2ETests.cs Fixed
@github-actions

This comment has been minimized.

Comment thread python/copilot/client.py Fixed
Comment thread python/e2e/test_mode_empty_e2e.py Fixed
[Fact]
public void CopilotClient_Mode_Empty_Accepts_Base_Directory()
{
var dir = Path.Combine(Path.GetTempPath(), "copilot-empty-mode-test-" + Guid.NewGuid().ToString("N"));
@SteveSandersonMS SteveSandersonMS force-pushed the stevesandersonms/session-profiles branch from d11f417 to f61b858 Compare May 27, 2026 16:35
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@SteveSandersonMS SteveSandersonMS marked this pull request as ready for review May 27, 2026 17:01
@SteveSandersonMS SteveSandersonMS requested a review from a team as a code owner May 27, 2026 17:01
Copilot AI review requested due to automatic review settings May 27, 2026 17:01
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an opt-in “empty” client mode across SDKs to support multi-tenant / untrusted-prompt hosts by forcing explicit tool allowlisting, stripping environment context from system prompts by default, and applying additional safe session options after create/resume.

Changes:

  • Introduces mode="empty" / ClientMode::Empty / ModeEmpty / CopilotClientMode.Empty and enforces extra validation (explicit storage + explicit availableTools).
  • Adds ToolSet builders and “isolated” built-in tool allowlists, plus tool-filter validation (reject bare "*").
  • Adds E2E + unit coverage across Node/Python/Go/Rust/.NET and shared CAPI proxy snapshots; updates wire payloads to send toolFilterPrecedence="excluded".
Show a summary per file
File Description
test/snapshots/mode_empty/empty_mode_system_message_replace_llm_follows_caller_content_verbatim.yaml New empty-mode E2E cassette for systemMessage: replace.
test/snapshots/mode_empty/empty_mode_strips_environment_context_from_the_system_message_by_default.yaml New empty-mode E2E cassette verifying env-context stripping.
test/snapshots/mode_empty/empty_mode_isolated_set_shell_tool_is_not_exposed.yaml New empty-mode E2E cassette for isolated built-in tool set.
test/snapshots/mode_empty/empty_mode_excluded_tools_subtracts_from_available_tools.yaml New empty-mode E2E cassette for allowlist+denylist composition.
test/snapshots/mode_empty/empty_mode_builtin_star_exposes_all_built_in_tools.yaml New empty-mode E2E cassette for builtin:*.
test/snapshots/mode_empty/empty_mode_append_caller_instruction_takes_effect_and_env_context_stripped.yaml New empty-mode E2E cassette for append→customize promotion + env stripping.
rust/tests/e2e/mode_empty.rs Rust E2E coverage mirroring Node cassettes.
rust/tests/e2e.rs Registers the new Rust E2E module.
rust/src/wire.rs Adds toolFilterPrecedence to create/resume wire payloads.
rust/src/types.rs Adds session option fields and ensures wire payload emits deny-wins precedence.
rust/src/session.rs Enforces empty-mode requirements, strips env context, defaults telemetry off, applies post-create option patch.
rust/src/mode.rs New Rust mode + ToolSet + isolated allowlist + validation helpers.
rust/src/lib.rs Exposes mode module + re-exports ClientMode, ToolSet, BUILTIN_TOOLS_ISOLATED; adds client option mode.
rust/src/generated/api_types.rs Schema/codegen updates (incl. options update enum + MCP auth config reshaping).
python/test_tool_set.py Python unit tests for ToolSet + empty-mode helpers.
python/e2e/test_mode_empty_e2e.py Python E2E tests sharing the same recorded snapshots.
python/copilot/client.py Adds mode, ToolSet support for tool filters, empty-mode defaults, and post-create patching.
python/copilot/_mode.py Implements Python ToolSet + isolated list + empty-mode validation/defaulting helpers.
python/copilot/init.py Re-exports ToolSet / mode types / isolated list.
nodejs/test/toolSet.test.ts Node unit tests for ToolSet, empty-mode validation/defaulting, and wire normalization.
nodejs/test/e2e/mode_empty.e2e.test.ts Node E2E tests for empty-mode behavior + tool exposure + env stripping.
nodejs/src/types.ts Adds CopilotClientMode, ToolSet-typed tool filters, and new session option flags.
nodejs/src/toolSet.ts Adds ToolSet builder and BuiltInTools.Isolated curated set.
nodejs/src/index.ts Exports ToolSet + BuiltInTools; exports CopilotClientMode type.
nodejs/src/generated/rpc.ts Schema/codegen updates (incl. toolFilterPrecedence type + MCP auth config reshaping).
nodejs/src/client.ts Implements empty-mode validation/defaulting, ToolSet normalization, toolFilterPrecedence, and post-create option patching.
nodejs/package.json Bumps @github/copilot dependency.
nodejs/package-lock.json Lockfile update for @github/copilot bump.
go/types.go Adds ClientOptions.Mode and new session option flags; wires toolFilterPrecedence + related fields.
go/toolset.go Adds Go ClientMode, ToolSet builder, and isolated built-in tool list.
go/toolset_test.go Go unit tests for ToolSet + empty-mode helpers.
go/rpc/zrpc.go Generated RPC updates for MCP auth config + toolFilterPrecedence enum.
go/rpc/zrpc_encoding.go Encoding updates for MCP auth config union decoding.
go/mode_empty.go Implements Go empty-mode validation/defaulting and post-create options patch.
go/internal/e2e/mode_empty_e2e_test.go Go E2E tests sharing recorded snapshots.
go/client.go Hooks empty-mode defaults/validation into create/resume + CLI env updates (disable keytar).
dotnet/test/Unit/ToolSetTests.cs .NET unit coverage for ToolSet and empty-mode construction constraints.
dotnet/test/E2E/ModeEmptyE2ETests.cs .NET E2E coverage mirroring other SDKs and recorded snapshots.
dotnet/src/Types.cs Adds CopilotClientMode + new session option flags and docs.
dotnet/src/ToolSet.cs Adds .NET ToolSet builder + BuiltInTools.Isolated.
dotnet/src/Generated/Rpc.cs Generated RPC updates for toolFilterPrecedence option.
dotnet/src/Client.cs Implements empty-mode validation/defaulting, tool filter validation, toolFilterPrecedence, and post-create option patching.

Copilot's findings

Files not reviewed (3)
  • go/rpc/zrpc.go: Language not supported
  • go/rpc/zrpc_encoding.go: Language not supported
  • nodejs/package-lock.json: Language not supported
Comments suppressed due to low confidence (2)

dotnet/src/Client.cs:855

  • If UpdateSessionOptionsForModeAsync throws after session.create succeeds, the catch block only calls RemoveFromClient() (unregisters locally) and does not send session.destroy to the runtime. In empty mode this can leave a running session with defaults the SDK failed to harden. Consider best-effort await session.DisposeAsync() / session.destroy in the failure path once the session has been created/resumed.
            session.WorkspacePath = response.WorkspacePath;
            session.SetCapabilities(response.Capabilities);
            session.SetOpenCanvases(response.OpenCanvases);

            await UpdateSessionOptionsForModeAsync(session, config, cancellationToken).ConfigureAwait(false);
        }
        catch (Exception ex)
        {
            session.RemoveFromClient();
            if (ex is not OperationCanceledException)
            {
                LoggingHelpers.LogTiming(_logger, LogLevel.Warning, ex,
                    "CopilotClient.CreateSessionAsync failed. Elapsed={Elapsed}, SessionId={SessionId}",
                    totalTimestamp,
                    sessionId);
            }
            throw;

dotnet/src/Client.cs:1030

  • ResumeSessionAsync has the same failure-mode as CreateSessionAsync: if UpdateSessionOptionsForModeAsync (or any later step) throws after the resume RPC succeeds, the catch path only unregisters locally and does not send session.destroy to the runtime. Consider best-effort disposing/destroying the runtime session in this failure path, especially for empty mode hardening.
            await UpdateSessionOptionsForModeAsync(session, config, cancellationToken).ConfigureAwait(false);
        }
        catch (Exception ex)
        {
            session.RemoveFromClient();
            if (ex is not OperationCanceledException)
            {
                LoggingHelpers.LogTiming(_logger, LogLevel.Warning, ex,
                    "CopilotClient.ResumeSessionAsync failed. Elapsed={Elapsed}, SessionId={SessionId}",
                    totalTimestamp,
                    sessionId);
            }
            throw;
  • Files reviewed: 36/43 changed files
  • Comments generated: 6

Comment thread nodejs/src/client.ts Outdated
Comment thread nodejs/src/client.ts
Comment thread nodejs/src/client.ts
Comment thread nodejs/src/toolSet.ts
Comment thread python/copilot/_mode.py Outdated
Comment thread go/toolset.go Outdated
@github-actions

This comment has been minimized.

Steve Sanderson and others added 4 commits May 27, 2026 18:54
Adds Node SDK surface for the multitenancy hardening work in
github/copilot-agent-runtime#7155 (runtime PR #8760).

- New `mode: "empty" | "copilot-cli"` on CopilotClientOptions; empty
  mode requires baseDirectory or sessionFs and rejects sessions
  without explicit availableTools.
- New ToolSet builder + BuiltInTools.Isolated constant for ergonomic,
  source-qualified tool patterns (builtin:*, mcp:*, custom:*).
- availableTools / excludedTools now accept ToolSet or string[]; bare
  "*" is rejected with a clear error pointing at the source-qualified
  forms.
- New toolFilterMode option ("allowPrecedence" | "denyPrecedence");
  empty mode defaults to denyPrecedence so apps can compose
  include+exclude.
- Unit tests (18) and e2e tests (3) including recorded CapiProxy
  snapshots.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The SDK no longer exposes 'toolFilterMode'. Every session.create / session.resume request now sends toolFilterMode: 'denyPrecedence' unconditionally, so SDK callers always get composable include+exclude semantics (a tool is enabled when it matches availableTools — or availableTools is unset — AND it does not match excludedTools).

Allowlist-precedence remains available on the runtime side as a CLI-only concession to legacy behavior; SDK consumers don't need it and the toggle was just extra surface area.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…recedence -> excluded

Mirrors the rename landed in the runtime PR. Also regenerates rpc.ts
to pick up the new toolFilterPrecedence field on SessionUpdateOptionsParams,
and renames the corresponding E2E capture snapshot.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-Authored-By: Copilot <223556219+Copilot@users.noreply.github.com>
SteveSandersonMS and others added 11 commits May 27, 2026 18:55
Port of nodejs/src/client.ts mode=empty work (commits 78e7280..61f8694)
to the .NET SDK.

- Add CopilotClientMode enum (Empty, CopilotCli) and Mode field on
  CopilotClientOptions; validation in constructor requires BaseDirectory,
  SessionFs, or UriRuntimeConnection when Mode=Empty.
- Add ToolSet builder and BuiltInTools.Isolated curated set in
  dotnet/src/ToolSet.cs. ToolSet inherits from List<string> so instances
  can be assigned directly to AvailableTools/ExcludedTools.
- Tool-filter resolution always emits toolFilterPrecedence=excluded on
  the wire (CreateSessionRequest/ResumeSessionRequest). Bare "*" rejected.
  Empty mode requires AvailableTools.
- Empty-mode safe defaults applied in Create/Resume:
  - environment_context stripped from system message
  - EnableSessionTelemetry=false (caller wins)
  - post-create session.options.update patch sets installedPlugins=[]
    plus 4 opt-back-in flags (SkipCustomInstructions=true,
    CustomAgentsLocalOnly=true, CoauthorEnabled=false,
    ManageScheduleEnabled=false), caller wins
  - COPILOT_DISABLE_KEYTAR=1 env in spawned CLI
- Add SessionConfigBase fields for the 4 opt-back-in flags.
- Add E2E tests at dotnet/test/E2E/ModeEmptyE2ETests.cs (6 tests) sharing
  recorded cassettes with the Node SDK under test/snapshots/mode_empty/.
- Regenerate dotnet/src/Generated/Rpc.cs against runtime branch schema to
  expose OptionsUpdateToolFilterPrecedence.
- Tidy: rename existing mode_empty cassettes to clean snake_case names
  shared across all language SDKs; update Node test titles to match.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Mirrors the C#/Node Mode=Empty implementation:
- ClientMode (ModeEmpty/ModeCopilotCli) + Mode field on ClientOptions
- ToolSet builder with AddBuiltIn/AddMcp/AddCustom + BuiltInToolsIsolated
- Tool-name charset validation (panics on /[^a-zA-Z0-9_-]/)
- NewClient validation: empty mode requires BaseDirectory, SessionFs, or
  UriConnection
- 4 opt-back-in fields on SessionConfig and ResumeSessionConfig
  (SkipCustomInstructions, CustomAgentsLocalOnly, CoauthorEnabled,
  ManageScheduleEnabled)
- ToolFilterPrecedence on createSessionRequest/resumeSessionRequest
- Mode helpers: resolveToolFilterOptions, systemMessageForMode (strips
  environment_context), applyConfigDefaultsForMode (telemetry off),
  updateSessionOptionsForMode (post-create patch)
- COPILOT_DISABLE_KEYTAR=1 in spawned runtime env when Mode=ModeEmpty
- toolset_test.go unit tests (16/16 passing)
- mode_empty_e2e_test.go reuses the shared test/snapshots/mode_empty/
  cassettes

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…aults)

Mirrors the Node implementation from the same PR:

- CopilotClientMode = Literal["copilot-cli", "empty"], default "copilot-cli"
- ToolSet builder with add_builtin / add_mcp / add_custom; entries are
  source-qualified strings (builtin:*/mcp:*/custom:*) — no bare wildcard
- BUILTIN_TOOLS_ISOLATED — built-ins safe for single-session, no-host-state
  contexts (ask_user, task_complete, exit_plan_mode, subagent helpers, …)
- _CopilotClientOptions.mode + CopilotClient(mode=...) kwarg
- Empty mode validates base_directory or session_fs or URI connection at
  construction time
- create_session / resume_session: validate available_tools is set in empty
  mode; reject bare "*"; normalize ToolSet -> list[str]; transform
  system_message to strip environment_context; default
  enable_session_telemetry to False; always emit toolFilterPrecedence
  "excluded"
- 4 opt-back-in SessionConfig fields: skip_custom_instructions,
  custom_agents_local_only, coauthor_enabled, manage_schedule_enabled —
  applied via session.options.update after create/resume. installedPlugins
  is forced to [] in empty mode. Failure to apply the patch tears the
  session down so empty-mode callers never end up with a permissive session.
- Runtime spawn env: COPILOT_DISABLE_KEYTAR=1 when mode="empty"
- Exports new symbols from `copilot` package
- 40 unit tests in python/test_tool_set.py covering the builder and helpers

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Ports the empty-mode SDK feature from Node (commits 78e7280..61f8694)
to the Rust SDK:

- Add `tool_filter_precedence: "excluded"` to SessionCreate/SessionResume
  wire payloads (always sent, matching Node).
- `create_session` / `resume_session`:
  - Reject empty mode when `available_tools` is unset.
  - Validate `available_tools` / `excluded_tools` reject bare "*".
  - Apply `system_message_for_mode` to strip `environment_context` in
    empty mode unless the caller has already overridden it.
  - Default `enable_session_telemetry = false` in empty mode when unset.
  - After session creation succeeds, send a `session.options.update`
    patch with safe defaults (skipCustomInstructions=true,
    customAgentsLocalOnly=true, coauthorEnabled=false,
    manageScheduleEnabled=false, installedPlugins=[]). If the patch
    fails, disconnect the session and propagate the error.
  - In copilot-cli mode, the same patch is sent only for fields the
    caller explicitly provided on the SessionConfig.
- Add `with_*` builders on SessionConfig and ResumeSessionConfig for
  the four opt-back-in fields.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
CI runs `cargo +nightly-2026-04-14 fmt --all -- --config-path .rustfmt.nightly.toml`

after codegen. Local codegen only invoked stable rustfmt, leaving these
3 files with unconsolidated imports that nightly rustfmt collapses.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- go/types.go: gofmt re-aligns struct fields after adding
  ToolFilterPrecedence field with a longer type name.
- python: ruff format/lint --fix on mode_empty test, _mode, client.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- nodejs/dotnet/go: best-effort disconnect/destroy session when the
  post-create options.update RPC fails so empty mode never leaves a
  runtime session alive with permissive defaults. Logic lives inside
  updateSessionOptionsForMode so call sites stay one line.
- python: same cleanup already happens; harden it so a failing
  disconnect doesn't mask the original error.
- python _normalize_tool_filter: reject bare str so passing
  'builtin:bash' fails fast instead of silently splitting into chars.
- nodejs client.ts: fix doc comment claiming append-mode is rejected
  in empty mode (we promote it to customize).
- go toolset.go: drop misleading 'implicit conversion' wording.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Comment thread python/copilot/client.py
self._sessions.pop(session.session_id, None)
try:
await session.disconnect()
except BaseException:
Comment thread dotnet/src/Client.cs
Comment on lines +702 to +705
catch
{
// Swallow: original error is what the caller needs.
}
@SteveSandersonMS SteveSandersonMS force-pushed the stevesandersonms/session-profiles branch from 6fc1c7d to aedf2c3 Compare May 27, 2026 17:58
@github-actions
Copy link
Copy Markdown
Contributor

Cross-SDK Consistency Review ✅ (with one gap noted)

The PR adds the Client Mode / ToolSet feature consistently across Node.js, .NET, Go, Python, and Rust — all five look well-aligned on:

Feature Node.js .NET Go Python Rust Java
ClientMode / mode option "empty" CopilotClientMode.Empty ClientMode ClientMode ClientMode
ToolSet builder
BuiltInTools / BuiltinTools
toolFilterMode on session config
Empty-mode construction-time validation
Empty-mode createSession validation
E2E tests for mode=empty

Java SDK gap

The Java SDK (java/) is the only implementation not updated in this PR. It currently has:

  • SessionConfig.setAvailableTools(List<String>) / setExcludedTools(List<String>) — accepts raw strings only, no ToolSet builder
  • No mode field on CopilotClientOptions
  • No ClientMode enum
  • No BuiltinTools constants (e.g. BuiltinTools.ISOLATED)
  • No toolFilterMode on SessionConfig
  • No construction-time or createSession-time validation for empty mode

This is already tracked as a follow-up checkbox in the PR description, so no action is required before merging — just flagging for completeness. When the Java implementation lands, the equivalent API would be:

// New: ClientMode enum
public enum ClientMode { COPILOT_CLI, EMPTY }

// New: CopilotClientOptions.setMode(ClientMode)
var client = new CopilotClient(new CopilotClientOptions()
    .setMode(ClientMode.EMPTY)
    .setBaseDirectory("/srv/agents"));

// New: ToolSet builder + BuiltinTools constants
var session = client.createSession(new SessionConfig()
    .setOnPermissionRequest(PermissionHandler.APPROVE_ALL)
    .setAvailableTools(new ToolSet()
        .addBuiltIn(BuiltinTools.ISOLATED)
        .addMcp("*"))
    .setExcludedTools(List.of("mcp:github-delete_repository"))).get();

No blocking issues for this PR — the five SDKs that are updated are consistent with each other.

Generated by SDK Consistency Review Agent for issue #1428 · ● 4M ·

@SteveSandersonMS SteveSandersonMS merged commit 6010405 into main May 27, 2026
43 checks passed
@SteveSandersonMS SteveSandersonMS deleted the stevesandersonms/session-profiles branch May 27, 2026 18:39
MackinnonBuck added a commit that referenced this pull request May 28, 2026
Previously, all SDKs unconditionally defaulted mcpOAuthTokenStorage to
"in-memory". With the client mode system from PR #1428, the safe
multitenant default now only applies in "empty" mode. In "copilot-cli"
mode, the property is not sent, letting the runtime default to
"persistent" (backward compatible).

Changes across all 6 SDKs:
- Node.js: configDefaultsForMode() sets default for empty mode only
- Python: _mcp_oauth_token_storage_default() helper checks mode
- Go: applyConfigDefaultsForMode/applyResumeDefaultsForMode set default
- .NET: ApplyConfigDefaultsForMode() uses ??= for empty mode
- Rust: Default impls return None; session.rs applies for empty mode
- Java: CopilotClient applies default in empty mode blocks

Tests updated to verify mode-specific behavior in all SDKs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
edburns pushed a commit to edburns/copilot-sdk that referenced this pull request May 28, 2026
* feat: add mcpOAuthTokenStorage support across all SDKs

Add the mcpOAuthTokenStorage protocol property to session creation and
resume flows in all five language SDKs (Node.js, Python, Go, .NET, Rust).

When set to "in-memory", the runtime uses an in-memory MCP OAuth token
store instead of the OS keychain. The SDK defaults to "in-memory" for
safe multitenant behavior.

- Node.js: Add to SessionConfig interface and ResumeSessionConfig Pick type
- Python: Add to both TypedDicts and client methods with docstrings
- Go: Add to config structs, wire request structs, and client wiring
- .NET: Add McpOAuthTokenStorageMode enum with JsonStringEnumConverter,
  update config classes, copy constructors, wire records, and serialization
  context
- Rust: Add field, builder methods, Default/new impls, and Debug impls

Tests:
- Rust: Assert defaults and builder composition in existing type tests
- .NET: Add property to SessionConfig_Clone_CopiesAllProperties test
- Go: Add wire serialization tests for both request types

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix(go): rename McpOAuthTokenStorage to MCPOAuthTokenStorage

Follow Go naming convention for initialisms (consistent with MCPServers).
Also fixes JSON tags that were accidentally changed from camelCase wire
format during the rename.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix(go): add error handling in MCPOAuthTokenStorage omit subtests

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* test(nodejs): add mcpOAuthTokenStorage default and forwarding tests

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* test(python): add mcp_oauth_token_storage default and forwarding tests

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix(python): use current CopilotClient constructor in mcpOAuthTokenStorage tests

Replace SubprocessConfig positional arg (removed in main) with
keyword-only connection=RuntimeConnection.for_stdio(path=CLI_PATH),
matching the pattern used by all other tests in the file.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* feat(java): add mcpOAuthTokenStorage support

Add mcpOAuthTokenStorage field to SessionConfig, ResumeSessionConfig,
CreateSessionRequest, and ResumeSessionRequest. The SessionRequestBuilder
defaults to "in-memory" for safe multitenant behavior, consistent with
all other SDK implementations.

Includes 6 unit tests covering default and explicit value forwarding for
both create and resume paths, plus null config handling.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix MCP OAuth test regressions

Update the Python MCP OAuth request interception tests to forward keyword arguments introduced by the merged create_session path, and add focused .NET clone tests so McpOAuth coverage can be validated directly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Move mcpOAuthTokenStorage default to empty (multitenant) mode only

Previously, all SDKs unconditionally defaulted mcpOAuthTokenStorage to
"in-memory". With the client mode system from PR github#1428, the safe
multitenant default now only applies in "empty" mode. In "copilot-cli"
mode, the property is not sent, letting the runtime default to
"persistent" (backward compatible).

Changes across all 6 SDKs:
- Node.js: configDefaultsForMode() sets default for empty mode only
- Python: _mcp_oauth_token_storage_default() helper checks mode
- Go: applyConfigDefaultsForMode/applyResumeDefaultsForMode set default
- .NET: ApplyConfigDefaultsForMode() uses ??= for empty mode
- Rust: Default impls return None; session.rs applies for empty mode
- Java: CopilotClient applies default in empty mode blocks

Tests updated to verify mode-specific behavior in all SDKs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix stale doc comments for mcp_oauth_token_storage in Rust

The doc comments incorrectly stated the default came from
SessionConfig::default(). Updated to reflect that the in-memory default
is applied at the client level when ClientMode::Empty is active.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix formatting in Node.js and Python test files

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix Python type annotation for _mcp_oauth_token_storage_default

Use Literal type instead of str to match the parameter type in client.py,
fixing the red-knot invalid-assignment diagnostic.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Add base_directory to Python empty mode tests

Empty mode requires base_directory to avoid falling back to ~/.copilot.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
krukow added a commit to copilot-community-sdk/copilot-sdk-clojure that referenced this pull request Jun 2, 2026
…114)

* feat(tool-set): add github.copilot-sdk.tool-set namespace + isolated preset

Source-qualified tool filter constructors (builtin/mcp/custom + builtins
vector form) plus isolated-builtins / isolated for parity with upstream
BuiltInTools.Isolated. Bare "*" is rejected at construction time.

Adds fdef specs in instrument.clj for every public fn so integration
tests with instrumentation enabled catch contract violations.

Mirrors upstream nodejs/src/toolSet.ts from PR github/copilot-sdk#1428
github/copilot-sdk#1428

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* feat(client): implement client mode :empty (multitenancy hardening)

Add :mode #{:copilot-cli :empty} client option (default :copilot-cli)
mirroring upstream PR github/copilot-sdk#1428.

In :empty mode the SDK:

- Requires at least one tenant-scoped storage root at construction time
  (:copilot-home, :session-fs, :cli-url, or :is-child-process?) so the
  spawned CLI never falls back to the user's home directory.
- Forces COPILOT_DISABLE_KEYTAR=1 on the spawned CLI via the
  cli-env-overrides :overrides slot so the caller cannot accidentally
  re-enable the host keychain.
- Requires every create-session / resume-session call (sync + async) to
  supply :available-tools; an empty vector is legitimate, the key just
  has to be present so silently-empty filters cannot happen.
- Spreads 9 safe defaults UNDER caller session config (caller always
  wins): :enable-session-telemetry? false,
  :mcp-oauth-token-storage :in-memory, :skip-embedding-retrieval true,
  :embedding-cache-storage :in-memory,
  :enable-on-demand-instruction-discovery false,
  :enable-file-hooks false, :enable-host-git-operations false,
  :enable-session-store false, :enable-skills false.
- Normalizes :system-message so environment_context is stripped unless
  the app has taken control of it (mirrors upstream
  getSystemMessageConfigForMode): no system-message emits
  {:mode customize :sections {:environment_context {:action remove}}};
  :append is promoted to :customize preserving content; :customize
  without an env-context override gets one added; :replace passes
  through unchanged. :copilot-cli mode keeps legacy behavior.
- After session.create / session.resume succeeds, issues a follow-up
  session.options.update RPC carrying four overridable feature flags
  (:skip-custom-instructions true, :custom-agents-local-only true,
  :coauthor-enabled false, :manage-schedule-enabled false) plus
  :installed-plugins []. In :copilot-cli mode only flags the caller
  explicitly set are forwarded; an empty patch skips the RPC entirely.
  On failure the SDK disconnects and removes the half-configured
  session before rethrowing. Wired into create-session,
  resume-session, <create-session, <resume-session.

Both modes always emit :tool-filter-precedence "excluded" on
session.create / session.resume so the ordering between
:available-tools and :excluded-tools is deterministic regardless of
CLI version, and reject bare "*" in :available-tools / :excluded-tools
at the SDK boundary (matches upstream resolveToolFilterOptions).

Adds 23 new integration tests covering validation, env-var overrides,
wire payload mode-defaults, system-message normalization, and the
session.options.update RPC (including async path + cleanup-on-failure).
339 tests / 1578 assertions / 0 failures.

Upstream: github/copilot-sdk#1428

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* docs: document client mode :empty + empty_mode example

- doc/reference/API.md: add :mode client option to constructor table,
  add 4 new session-config flags (skip-custom-instructions,
  custom-agents-local-only, coauthor-enabled, manage-schedule-enabled)
  to the session-config table, and add two new sections under Advanced
  Usage:
  - 'Client Mode (Empty)' — runnable example, mode semantics, the 9
    config defaults, system-message normalization, options.update
    flags, and the always-emit tool-filter-precedence guarantee.
  - 'Tool Sets' — github.copilot-sdk.tool-set API surface (builtin /
    mcp / custom / builtins / isolated) with the bare-* rejection
    rationale.
- CHANGELOG.md: new [Unreleased] section for upstream PR #1428,
  remove the matching 'deferred from round 6' bullet (no longer
  deferred — ported here).
- examples/empty_mode.clj: BYOK-based runnable example showing temp
  copilot-home + in-memory session-fs + tool-set/isolated. Excluded
  from run-all-examples.sh because empty mode disables the local
  keychain and the example requires OPENAI_API_KEY or
  ANTHROPIC_API_KEY.
- examples/README.md: example 20 entry, prerequisites note.
- doc/index.md: bump example count to 20.

Upstream: github/copilot-sdk#1428

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* fix(client): offload blocking options.update cleanup to async/thread

The async <apply-session-options-update! ran cleanup-failed-options-update!
directly inside its go block on RPC failure. That cleanup calls session/disconnect!,
which uses blocking proto/send-request! (5s timeout) and other side effects.
Blocking work inside a go block can starve the core.async dispatch threadpool
and stall unrelated async flows.

Offload the cleanup to async/thread and <! it from the go block before
delivering the Throwable, matching the existing convention used in
session.clj for blocking user-handler work.

Also adds:
- A regression test (test-empty-mode-options-update-async-failure-cleans-up-session)
  asserting the async path yields a Throwable and removes the half-configured
  session from the registry after an options.update failure.
- A regression test (test-empty-mode-system-message-customize-no-sections-key)
  covering :customize without a :sections key — locks in the existing
  (contains? nil ...) → false → add :sections semantics so the behavior
  cannot regress.

Addresses Copilot Code Review feedback on PR #114.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants