NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI, #3220 most downloaded on PyPI
Python SDK for GitHub Copilot CLI
Latest stable
1.0.31
Last release 10 days ago
10 Nov 2026
Ships on a steady schedule
a new release about every 8 days
Nearly every release is documented
notes for 49 of 53 stable releases
1 version withdrawn
withdrawn after publishing
10 months old
184 releases · first in 2026
Drag across the ruler to compare, or tap a release to open it.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.21...v1.0.22-preview.0
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.21...v1.0.22-preview.0
improvement: [All SDKs] regenerate RPC and session event types against Copilot CLI 1.0.97 (new catalog agent plugin/media type fields and updated sess
PermissionHandlersFull Changelog: https://github.com/github/copilot-sdk/compare/v1.0.19...v1.0.21
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 22.9 AIC · ⌖ 0.544 AIC · ⊞ 10.5K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38450169734, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38450169734 -->
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Internal dependency updates only: this prerelease refreshes the SDK snapshot for Copilot CLI 1.0.97-3. There are no other user-visible changes since v
Internal dependency updates only: this prerelease refreshes the SDK snapshot for Copilot CLI 1.0.97-3. There are no other user-visible changes since v1.0.21-preview.2.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 17 AIC · ⌖ 0.543 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38432509602, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38432509602 -->
Internal dependency updates only (SDK snapshot refreshed for Copilot CLI 1.0.97-2).
Internal dependency updates only (SDK snapshot refreshed for Copilot CLI 1.0.97-2).
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.21-preview.1...v1.0.21-preview.2
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 18 AIC · ⌖ 0.549 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38331861005, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38331861005 -->
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.97-1).
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.97-1).
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 16.4 AIC · ⌖ 0.543 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38320615662, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38320615662 -->
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.97-0).
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.97-0).
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 15.1 AIC · ⌖ 0.545 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38308104057, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38308104057 -->
Nothing published for this version
Internal dependency updates only (SDK snapshot update for Copilot CLI 1.0.96-2). No user-visible SDK changes since v1.0.20-preview.1.
Internal dependency updates only (SDK snapshot update for Copilot CLI 1.0.96-2). No user-visible SDK changes since v1.0.20-preview.1.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.20-preview.1...v1.0.20-preview.2
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 20 AIC · ⌖ 0.545 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38016879701, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38016879701 -->
Internal dependency updates only. No user-visible SDK changes since v1.0.20-preview.0.
Internal dependency updates only. No user-visible SDK changes since v1.0.20-preview.0.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 16.5 AIC · ⌖ 0.543 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 38008933612, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/38008933612 -->
Internal dependency updates only (updated to Copilot CLI 1.0.96-0). No user-visible SDK changes since v1.0.19.
Internal dependency updates only (updated to Copilot CLI 1.0.96-0). No user-visible SDK changes since v1.0.19.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 15 AIC · ⌖ 0.546 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37981959291, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37981959291 -->
Internal dependency updates only (Copilot CLI snapshot updates); no user-visible SDK changes in this release.
Internal dependency updates only (Copilot CLI snapshot updates); no user-visible SDK changes in this release.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18...v1.0.19
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 19.2 AIC · ⌖ 0.544 AIC · ⊞ 10.5K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37958098905, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37958098905 -->
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.19-preview.2...v1.0.19-preview.3
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.19-preview.2...v1.0.19-preview.3
Internal dependency updates only (Copilot CLI snapshot update).
Internal dependency updates only (Copilot CLI snapshot update).
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.19-preview.1...v1.0.19-preview.2
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 15.4 AIC · ⌖ 0.546 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37876340603, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37876340603 -->
Internal dependency updates only (Copilot CLI snapshot update to 1.0.95-1).
Internal dependency updates only (Copilot CLI snapshot update to 1.0.95-1).
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.19-preview.0...v1.0.19-preview.1
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 15.3 AIC · ⌖ 0.549 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37866958480, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37866958480 -->
Internal dependency updates only (Copilot CLI 1.0.95-0 snapshot update); no user-visible SDK changes in this prerelease.
Internal dependency updates only (Copilot CLI 1.0.95-0 snapshot update); no user-visible SDK changes in this prerelease.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 15.9 AIC · ⌖ 0.542 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37854102381, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37854102381 -->
Nothing published for this version
Internal dependency updates only (SDK snapshot updated for the latest Copilot CLI, 1.0.94). No user-visible SDK changes since v1.0.17.
Internal dependency updates only (SDK snapshot updated for the latest Copilot CLI, 1.0.94). No user-visible SDK changes since v1.0.17.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.17...v1.0.18
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 17 AIC · ⌖ 0.545 AIC · ⊞ 10.5K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37841535123, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37841535123 -->
Internal dependency updates only (SDK snapshot updated for the latest Copilot CLI prerelease).
Internal dependency updates only (SDK snapshot updated for the latest Copilot CLI prerelease).
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.4...v1.0.18-preview.5
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 16.7 AIC · ⌖ 0.543 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37822220010, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37822220010 -->
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.94-4).
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.94-4).
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.3...v1.0.18-preview.4
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 15.3 AIC · ⌖ 0.544 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37779471403, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37779471403 -->
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.2...v1.0.18-preview.3
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.2...v1.0.18-preview.3
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.1...v1.0.18-preview.2
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.1...v1.0.18-preview.2
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.0...v1.0.18-preview.1
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.18-preview.0...v1.0.18-preview.1
Internal dependency updates only (updated SDK snapshot for Copilot CLI 1.0.94-0). No user-visible SDK changes since v1.0.17.
Internal dependency updates only (updated SDK snapshot for Copilot CLI 1.0.94-0). No user-visible SDK changes since v1.0.17.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 18.3 AIC · ⌖ 7.09 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37668900264, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37668900264 -->
A live session's client-supplied tools and handlers can now be replaced in a single call without recreating the session. Built-in, MCP, and plugin too
A live session's client-supplied tools and handlers can now be replaced in a single call without recreating the session. Built-in, MCP, and plugin tools are unaffected; pass an empty list to remove all of this client's tools. (ef04633)
await session.setTools([tool])await session.SetToolsAsync(tools)await session.set_tools([tool])session.SetTools(ctx, tools)session.setTools(tools).get()session.set_tools([tool]).await?Register OnSubagentStart and OnSubagentStop hooks on the parent session. Start hooks can prepend context to a sub-agent's first prompt. Stop hooks can inspect the response, replace it, or block the stop with a follow-up instruction. (6b4f3a3)
Hooks = new SessionHooks { OnSubagentStart = (input, inv) =>
Task.FromResult(new() { AdditionalContext = "Read the file first." }) }
Hooks: &copilot.SessionHooks{OnSubagentStart: func(in copilot.SubagentStartHookInput, inv copilot.HookInvocation) (*copilot.SubagentStartHookOutput, error) {
return &copilot.SubagentStartHookOutput{AdditionalContext: "Read the file first."}, nil }}
A session filesystem provider can now serve exact file bytes, so the view tool can read provider-only images. Implement the binary provider interface and set Capabilities.Binary. Reads and writes are capped at about 48 MiB. (6b4f3a3)
ISessionFsBinaryProvider (ReadFileBytesAsync, WriteFileBytesAsync)SessionFSBinaryProvider (ReadFileBytes, WriteFileBytes)tool.shell_output and human_response.recorded, plus file-edit details on tool.execution_complete (6b4f3a3)Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.16...v1.0.17
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 30.3 AIC · ⌖ 5.15 AIC · ⊞ 10.5K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37636214912, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37636214912 -->
Internal dependency updates only: this prerelease updates the SDK snapshot for Copilot CLI 1.0.93-4, with no user-visible SDK API changes.
Internal dependency updates only: this prerelease updates the SDK snapshot for Copilot CLI 1.0.93-4, with no user-visible SDK API changes.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.17-preview.9...v1.0.17-preview.10
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 21.9 AIC · ⌖ 6.24 AIC · ⊞ 10.6K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37577920875, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37577920875 -->
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.17-preview.8...v1.0.17-preview.9
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.17-preview.8...v1.0.17-preview.9
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.17-preview.4...v1.0.17-preview.8
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.17-preview.4...v1.0.17-preview.8
Nothing published for this version
Nothing published for this version
Nothing published for this version
Register OnSubagentStart and OnSubagentStop hooks on the parent session. Start hooks can prepend context to a sub-agent's first prompt. Stop hooks can
Register OnSubagentStart and OnSubagentStop hooks on the parent session. Start hooks can prepend context to a sub-agent's first prompt. Stop hooks can inspect the response, replace it, or block the stop with a follow-up instruction. (6b4f3a3)
Hooks = new SessionHooks { OnSubagentStart = (input, inv) =>
Task.FromResult<SubagentStartHookOutput?>(new() { AdditionalContext = "Read the file first." }) }
Hooks: &copilot.SessionHooks{OnSubagentStart: func(in copilot.SubagentStartHookInput, inv copilot.HookInvocation) (*copilot.SubagentStartHookOutput, error) {
return &copilot.SubagentStartHookOutput{AdditionalContext: "Read the file first."}, nil }}
A session filesystem provider can now serve exact file bytes, so the view tool can read provider-only images. Implement the binary provider interface and set Capabilities.Binary. Reads and writes are capped at about 48 MiB. (6b4f3a3)
ISessionFsBinaryProvider (ReadFileBytesAsync, WriteFileBytesAsync)SessionFSBinaryProvider (ReadFileBytes, WriteFileBytes)tool.shell_output and human_response.recorded, plus file-edit details on tool.execution_complete (6b4f3a3)[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 33.3 AIC · ⌖ 6.48 AIC · ⊞ 10.4K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37229465752, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37229465752 -->
A live session's client-supplied tools and handlers can now be replaced in a single call without recreating the session. Built-in, MCP, and plugin too
A live session's client-supplied tools and handlers can now be replaced in a single call without recreating the session. Built-in, MCP, and plugin tools are unaffected; pass an empty list to remove all of this client's tools. (ef04633)
await session.setTools([tool])await session.SetToolsAsync(tools)await session.set_tools([tool])session.SetTools(ctx, tools)session.setTools(tools).get()session.set_tools([tool]).await?[!WARNING] <details> <summary>Firewall blocked 2 domains</summary>
The following domains were blocked by the firewall during workflow execution:
api.github.comgithub.com[!TIP]
api.github.comis blocked because GitHub API access uses the built-in GitHub tools by default. Instead of addingapi.github.comtonetwork.allowed, usetools.github.mode: gh-proxyfor direct pre-authenticated GitHub CLI access without requiring network access toapi.github.com:tools: github: mode: gh-proxySee GitHub Tools for more information on
gh-proxymode.To allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "api.github.com" - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 26.9 AIC · ⌖ 5.65 AIC · ⊞ 10.4K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37071930692, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37071930692 -->
improvement: [C#] add a custom session event JSON converter and updated generated session event types for Copilot CLI 1.0.92-2
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 17.5 AIC · ⌖ 6.05 AIC · ⊞ 10.4K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 37053159174, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/37053159174 -->
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.16...v1.0.17-preview.1
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.16...v1.0.17-preview.1
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Internal dependency updates only: this release refreshes the SDK snapshot for Copilot CLI 1.0.90. It contains no other user-visible SDK changes since
Internal dependency updates only: this release refreshes the SDK snapshot for Copilot CLI 1.0.90. It contains no other user-visible SDK changes since v1.0.15.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 18.8 AIC · ⌖ 6.11 AIC · ⊞ 10.3K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 36782902976, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/36782902976 -->
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.90-6).
Internal dependency updates only (SDK snapshot updated for Copilot CLI 1.0.90-6).
Full Changelog: https://github.com/github/copilot-sdk/compare/runtime-1.0.89-1.unstable.r36638597907.ge270afd...v1.0.16-preview.0
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 23.7 AIC · ⌖ 5.81 AIC · ⊞ 10.3K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 36751682486, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/36751682486 -->
Provide a JSON Schema, or use an idiomatic typed helper, to have the model return typed, validated output instead of free-form text.
Provide a JSON Schema, or use an idiomatic typed helper, to have the model return typed, validated output instead of free-form text. (#2590)
const answerSchema = z.object({ value: z.number().int() });
const answer = await session.sendAndWait("What is 19 + 23?", answerSchema);
answer = await session.send_and_wait_typed("What is 19 + 23?", Answer)
Go, Java, C#, and Rust get the same capability via copilot.SendAndWait[Answer], session.sendAndWait(prompt, Answer.class), SendAndWaitAsync<Answer>, and session.send_and_wait_typed(prompt).
The raw JSON data payload of a JSON-RPC error response can now be inspected in every SDK, so apps can branch on machine-readable error details. (#2664, #2732)
if let Some(data) = error.rpc_data() { println!("{data}"); }
catch (JsonRpcException e) { JsonNode data = e.getData(); }
All six SDKs expose a connection-global handler for the runtime's installations.confirm callback, letting apps present a human review before an MCP or Skill installation proceeds. The handler must return an explicit confirm/decline/cancel decision.
const client = new CopilotClient({
installationConfirmationHandler: async (request, context) => promptUser(request),
});
Java, Python, Rust, C#, and Go get equivalent options (setInstallationConfirmationHandler, installation_confirmation_handler, with_installation_confirmation_handler, InstallationConfirmationHandler). Java also now exposes typed unions for MCP installation review payloads.
darwin-x64 (#2701)linuxmusl-x64 (Alpine) (#2715)FusionCritic generated diagnostics type@mohamedmansour made their first contribution in #2676@roblourens made their first contribution in #2700[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 17.1 AIC · ⌖ 6.46 AIC · ⊞ 9K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 36473688933, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/36473688933 -->
All six SDKs now expose a connection-global handler for the runtime's installations.confirm callback, letting apps present a human review before an MC
All six SDKs now expose a connection-global handler for the runtime's installations.confirm callback, letting apps present a human review before an MCP or Skill installation proceeds. The handler receives the generated request plus a cancellation signal that fires when the review is retired or the connection closes, and must return an explicit confirm/decline/cancel decision — the SDK never infers approval.
const client = new CopilotClient({
installationConfirmationHandler: async (request, context) => {
return await promptUser(request); // "confirm" | "decline" | "cancel"
},
});
var options = new CopilotClientOptions
{
InstallationConfirmationHandler = async (request, context) =>
await PromptUserAsync(request, context.CancellationToken),
};
opts := copilot.ClientOptions{
InstallationConfirmationHandler: func(ctx context.Context, req *copilot.InstallationConfirmationRequest) (copilot.InstallationConfirmationDecision, error) {
return promptUser(ctx, req)
},
}
Java, Python, and Rust get the equivalent setInstallationConfirmationHandler(...), installation_confirmation_handler, and with_installation_confirmation_handler options. Java additionally converts the previously untyped MCP installation/removal review payloads (InstallationConfirmationRequest.review(), McpInstallPlan.transportChoices(), McpInstallationManagementResultOutcome.getOutcome()) into sealed/typed unions, bringing it into line with the other SDKs.
FusionCritic generated diagnostics type for execution-phase model/reasoning-effort tracking[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 169.2 AIC · ⌖ 5.87 AIC · ⊞ 9K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 36453748072, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/36453748072 -->
Go, .NET, and Java can now inspect the raw JSON data payload of a JSON-RPC error response instead of only its code and message. This mirrors capabilit
Go, .NET, and Java can now inspect the raw JSON data payload of a JSON-RPC error response instead of only its code and message. This mirrors capabilities already available in TypeScript, Python, and Rust, letting apps branch on machine-readable error details. (#2732)
var rpcErr *copilot.RPCError
if errors.As(err, &rpcErr) {
fmt.Printf("RPC error %d: %s\n", rpcErr.Code, rpcErr.Message)
}
catch (IOException ex) when (ex.InnerException is RemoteRpcException remote)
{
Console.Error.WriteLine($"RPC error {remote.ErrorCode}: {remote.Message}");
}
catch (JsonRpcException e) {
JsonNode data = e.getData();
}
Omitted data and explicit JSON null remain distinguishable in all three APIs, and existing error identity, wrapping, and formatting behavior are unchanged.
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 163.2 AIC · ⌖ 6.41 AIC · ⊞ 9K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 36062442302, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/36062442302 -->
Internal dependency updates only — this prerelease contains no user-visible SDK changes since v1.0.15-preview.1. The only changes are automated Copilo
Internal dependency updates only — this prerelease contains no user-visible SDK changes since v1.0.15-preview.1. The only changes are automated Copilot CLI snapshot updates for internal testing.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.15-preview.1...v1.0.15-preview.2
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 59.3 AIC · ⌖ 8.22 AIC · ⊞ 9K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 35918094282, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/35918094282 -->
Internal dependency updates only — this prerelease contains no user-visible SDK changes since v1.0.15-preview.0. The only changes are automated Copilo
Internal dependency updates only — this prerelease contains no user-visible SDK changes since v1.0.15-preview.0. The only changes are automated Copilot CLI snapshot updates for internal testing.
Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.15-preview.0...v1.0.15-preview.1
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Notes Generator · copilot · auto · 42.6 AIC · ⌖ 5.58 AIC · ⊞ 9K
<!-- gh-aw-agentic-workflow: Release Notes Generator, engine: copilot, model: auto, id: 35792423812, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/35792423812 -->
Provide a JSON Schema, or use an idiomatic typed helper, to have the model return typed, validated output instead of free-form text.
Provide a JSON Schema, or use an idiomatic typed helper, to have the model return typed, validated output instead of free-form text. (#2590)
const answerSchema = z.object({ value: z.number().int() });
const answer = await session.sendAndWait("What is 19 + 23?", answerSchema);
class Answer(BaseModel):
value: int
answer = await session.send_and_wait_typed("What is 19 + 23?", Answer)
var answer = await session.SendAndWaitAsync("What is 19 + 23?");
public sealed record Answer(int Value);
Go, Java, and Rust get the same capability via copilot.SendAndWait[Answer], session.sendAndWait(prompt, Answer.class), and session.send_and_wait_typed(prompt) respectively.
copilot::Error now preserves the optional data payload from JSON-RPC errors so callers can inspect machine-readable error details instead of just the message. (#2664)
if let Some(data) = error.rpc_data() {
println!("{data}");
}
darwin-x64 (#2701)linuxmusl-x64 (Alpine) (#2715)@roblourens made their first contribution in #2700[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Changelog Generator · copilot · auto · 86.4 AIC · ⌖ 5.24 AIC · ⊞ 9.9K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, model: auto, id: 35552629787, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/35552629787 -->
Nothing published for this version
Messages sent through the SDK can now carry typed source provenance, distinguishing human user input, internal system injections, and identified agent
Messages sent through the SDK can now carry typed source provenance, distinguishing human user input, internal system injections, and identified agent- senders, so recipients can reliably tell agent input from human authorization. (#2573)
await session.send("Looks good to me.", { source: "agent-reviewer" });
await session.send("Looks good to me.", source=AgentMessageSource("reviewer"))
Sessions using auto model routing can now select the fast tier alongside the existing efficiency, balance, and intelligence tiers, giving integrators a latency-focused routing preset across all six SDKs. (#2669)
await session.setAutoTier("fast");
The new managedSettings.clearCache RPC method wipes the persistent server-policy cache and drops the runtime's in-memory retained policy, giving hosts a primitive for a "force refresh account policy" action. (#2438)
await client.rpc.managedSettings.clearCache();
await client.Rpc.ManagedSettings.ClearCacheAsync();
SessionConfig and ResumeSessionConfig in the Rust SDK now accept an optional allowed_models list, letting hosts restrict which model IDs a session may use without duplicating runtime validation. (#2512)
let config = SessionConfig::default().with_allowed_models(["gpt-4o", "claude-3.7-sonnet"]);
max_output_tokens to the model capabilities override, previously unreachable without an unsafe cast (#2569)PackAsTool packages so dotnet pack --no-build produces a working tool (#2557)connection_close callback-quiescence contract consistently across all six in-process C ABI adapters, preventing races with freed callback state during disposal (#2610, #2622)CatalogTrustEligibility unknown value and re-exporting shared session-event types (#2631)anyOf/oneOf handling (#2656)@aurokin made their first contribution in #2573@kondv made their first contribution in #2557@1fanwang made their first contribution in #2569@SamMorrowDrums made their first contribution in #2258@SandraAhlgrimm made their first contribution in #2603@jpbufe3 made their first contribution in #2512[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Changelog Generator · copilot · auto · 73.3 AIC · ⌖ 9 AIC · ⊞ 10.3K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, model: auto, id: 35058939618, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/35058939618 -->
Agent Factories can now pause deliberately instead of only stopping at hard limits. Call ctx.pause(key) inside a factory body to register a durable, o
Agent Factories can now pause deliberately instead of only stopping at hard limits. Call ctx.pause(key) inside a factory body to register a durable, one-shot checkpoint that ends the current attempt; resuming replays the journal and returns from that checkpoint instead of redoing prior work. Callers can also pause a running attempt from outside the factory body. (#2537)
await ctx.step("prepare", prepareInput);
await ctx.pause("review-ready");
await ctx.agent("Review the prepared input");
const paused = await session.factory.pause(runId);
[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Changelog Generator · copilot · auto · 52.5 AIC · ⌖ 5.57 AIC · ⊞ 10.3K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, model: auto, id: 34876370301, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/34876370301 -->
bugfix: [.NET] fix a vulnerable transitive SourceLink dependency
Sending a message can now declare its source as user, system, or an identified agent (serialized as agent-<id>), so recipients can reliably distinguish human input from system injections and forwarded agent output. Ordinary sends remain unaffected: source stays omitted unless the caller opts in. (#2573)
await session.send({ prompt: "Reviewed and approved.", source: "agent-reviewer" });
await session.send(prompt="Reviewed and approved.", source=AgentMessageSource("reviewer"))
session.Send(ctx, copilot.SendOptions{Source: copilot.MessageSourceAgent("reviewer")})
Source = MessageSource.Agent("reviewer").setSource(MessageSource.agent("reviewer")).with_source(MessageSource::Agent("reviewer".into()))A new managedSettings.clearCache RPC wipes the persistent server-policy cache and drops the runtime's in-memory retained policy, so hosts can wire up a "sync account policy" action (for example VS Code's Developer: Sync Account Policy command). It's available in TypeScript, C#, Python, Go, and Rust; Java support follows once the underlying CLI release is pinned. (#2438)
await client.rpc.managedSettings.clearCache();
max_output_tokens on model capability overrides (#2569)PackAsTool publish output so packed tools install correctly (#2557)[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Changelog Generator · copilot · auto · 84.6 AIC · ⌖ 7 AIC · ⊞ 10.3K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, model: auto, id: 34855078063, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/34855078063 -->
Host-owned external tool callbacks are now cancelled when their runtime request completes or their SDK session terminates. The cancellation primitive
Host-owned external tool callbacks are now cancelled when their runtime request completes or their SDK session terminates. The cancellation primitive is idiomatic per SDK: .NET passes a request token to AIFunction, Node.js exposes ToolInvocation.signal, Go cancels ToolInvocation.TraceContext, Java cancels the returned CompletableFuture, Python cancels the handler task, and Rust drops the handler future. Go handlers that retain TraceContext for background work must derive a separate lifetime because the invocation context is cancelled when the request ends.
Client options now accept optional client info (application name and version, integration name and version) across all six SDKs, exposed idiomatically per language (clientInfo in Node.js, client_info in Python and Rust, ClientInfo in Go and .NET, setClientInfo in Java). When set, the SDK forwards it on the server.connect handshake so the telemetry the runtime emits on the connection is attributed to the application and its Copilot integration instead of the runtime's own build. All fields are optional, and leaving client info unset keeps the runtime's default attribution. See Client info.
The experimental Node.js Agent Factories convenience API now supports paginated run history. Existing session.factory.listRuns() calls still return the runs array, while calls with afterSeq, beforeSeq, or limit return the full page with cursor and truncation metadata.
Factory run and resume options now accept notifyOnComplete and logPhaseNames. The SDK forwards these options to the Copilot CLI for new and resumed runs.
ask_user session behaviorSession create and cold resume now accept a language-specific askUserVariant option with legacy and elicitation values. SDK sessions retain the legacy question-and-answer tool by default. Select elicitation and provide an elicitation handler to expose the structured form-based ask_user tool.
All six SDKs can now acquire short-lived GitHub credentials through a session-scoped callback. The SDK registers the callback before session create or resume, maps initial and refresh requests to the owning session, and removes registrations on rollback, replacement, session close, and client close. Static per-session gitHubToken credentials remain supported and are mutually exclusive with the callback.
Token responses use the shared tagged token/cancelled shape and require expiresIn, expressed as the positive number of seconds remaining when the callback completes. See github/copilot-agent-runtime#16381 for the runtime credential-authority implementation.
Initial acquisition occurs during create or resume; cancellation, callback errors, and invalid credentials reject that operation instead of falling back to ambient authentication. Idle sessions refresh only before their next credential-consuming operation.
Copilot CLI extensions can now ask for named sensitive environment variables when they join a session. joinSession() accepts a requestedEnvironmentVariables option listing the variable names the extension needs. The CLI shows a permission prompt naming the extension and the exact variables requested. On approval, only those variables reach that extension and their values are written into the extension process's process.env before joinSession() resolves. On denial, joinSession() rejects, the extension does not load, and its tools never reach the model.
An approval is remembered against the exact set of names the user saw, so an extension that later asks for one more variable prompts again. Names that are unset, or that the CLI does not filter from extensions, are not prompted for. This is the client half of the feature; it requires a Copilot CLI that supports extension environment access, and older CLIs ignore the request and grant nothing.
import { joinSession } from "@github/copilot-sdk/extension";
const session = await joinSession({
requestedEnvironmentVariables: ["GITHUB_TOKEN"],
});
const token = process.env.GITHUB_TOKEN;
The Rust SDK can now observe every event routed to a session, starting with that session's very first routed event. Client::prepare_session and Client::prepare_resume_session return an inert PreparedSession that owns the session's event channel, so a subscription can be installed before any protocol activity begins:
let prepared = client.prepare_session(
SessionConfig::default().with_event_buffer_capacity(2048),
)?;
let mut events = prepared.subscribe();
let session = prepared.start().await?;
Previously, Session::subscribe could only be called on the returned session, so events the runtime emitted while session.create / session.resume was still in flight were broadcast with no receiver installed and dropped. Ephemeral events such as session.idle are not persisted, so they could not be recovered with getMessages either.
The guarantee is scoped to routed events. For cloud sessions where the server assigns the session ID, the SDK cannot route notifications until the session.create response arrives and the ID is known, so events emitted before that point are not routable to any session. Pin session_id on the config to get router registration before the RPC, and with it complete pre-response coverage.
prepare_* is synchronous and inert: it validates the buffer capacity and allocates a local channel, and performs no router registration, task spawn, or wire activity until start() is first polled. start(self) consumes the handle and PreparedSession is not Clone, so a prepared session can never produce two event loops. Dropping an unstarted handle leaves no state behind; dropping a polled start() future cancels the startup and unregisters the session, so a retry with the same session ID succeeds. Session registrations now carry an ownership identity, so cleanup removes only the exact registration it owns and an abandoned startup can never evict a same-ID retry (or a session that replaced it).
Both SessionConfig and ResumeSessionConfig gained a runtime-only event_buffer_capacity option (default 512, Some(0) rejected as an invalid config). The buffer is finite, so slow subscribers observe Lagged rather than applying backpressure; consumers that need a lossless view of a large startup burst must size the buffer accordingly or drain concurrently with start().
create_session and resume_session are unchanged wrappers over prepare_*(...)?.start() with identical RPC sequences and error kinds.
Session create and resume accept a new optional managedSettings option that injects an enterprise permissions policy at session startup, alongside the existing enableManagedSettings self-fetch flag. The current contract is permissions-only: disableBypassPermissionsMode (the literal "disable"), plus deny, ask, and allow rule lists. The layer composes restrictively with any server- or device-level managed settings (deny/ask are unioned, every present allow list must admit a tool, and disableBypassPermissionsMode is deny-wins).
This layer is startup-only and is not persisted with the session, so it must be re-supplied on resume to remain in effect; omitting it on resume clears the previously injected layer. It can be combined with enableManagedSettings. Host injection requires Copilot CLI 1.0.79-5 or later and does not require an SDK protocol version bump.
The generated session-event types also expose truthful injected-policy provenance: session.managed_settings_resolved can report source as client or mixed, with optional clientManaged metadata.
const session = await client.createSession({
managedSettings: {
permissions: {
disableBypassPermissionsMode: "disable",
deny: ["shell(rm*)"],
ask: ["write"],
},
},
});
var session = await client.CreateSessionAsync(new SessionConfig
{
ManagedSettings = new ManagedSettings
{
Permissions = new ManagedSettingsPermissions
{
DisableBypassPermissionsMode = DisableBypassPermissionsMode.Disable,
Deny = ["shell(rm*)"],
Ask = ["write"],
},
},
});
Sessions can now steer auto model routing toward efficiency, balance, or intelligence. An Auto tier can be set at session creation, and a new setAutoTier (and equivalent setModel option) lets sessions stage or reset a tier preference afterward, since the runtime only commits a staged preference on the next successful auto model turn. (#2437, #2514)
await session.set_auto_tier("efficiency")
Sandbox configuration now exposes allowBypass across all six SDKs. External tool overrides such as apply_patch can also receive non-object JSON argument values, which previously failed before reaching the host handler in .NET. (#2372, #2496)
Session create and resume now accept a featureFlags map across all six SDKs, forwarding host-resolved overrides while preserving the distinction between an unset map and an explicitly empty one. (#2451)
session.detach instead of session.destroy for SDK session cleanup so disconnecting one client no longer tears down a shared session for other owners (#2307)ClientMode::Empty to no built-in skills (#2410)@lukehoban made their first contribution in #2292@scordio made their first contribution in #2382@OllieinCanada made their first contribution in #2374@gimenete made their first contribution in #2458@gwwar made their first contribution in #2464@Pybsama made their first contribution in #2163@green3sf made their first contribution in #2360@gokhanarkan made their first contribution in #2532[!WARNING] <details> <summary>Firewall blocked 1 domain</summary>
The following domain was blocked by the firewall during workflow execution:
github.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:network: allowed: - defaults - "github.com"See Network Configuration for more information.
</details>
Generated by Release Changelog Generator · copilot · auto · 125.2 AIC · ⌖ 8.09 AIC · ⊞ 11.7K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, model: auto, id: 33922002730, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/33922002730 -->
Nothing published for this version
Nothing published for this version
> Rust breaking change: PermissionResult::Decision changed from a tuple variant to a struct variant ({ decision, context }). Code using result helpers…
Sessions can now opt into file-change tracking and rewind conversation history and tracked file changes to any prior checkpoint. Enable file tracking when creating a session, then use rewind to roll back. (#2321)
const session = await client.createSession({ enableFileChangeTracking: true });
// ...later
const points = await session.rpc.rewind.list();
await session.rpc.rewind.rewind({ rewindTarget: points[0].id });
var session = await client.CreateSessionAsync(new SessionOptions { EnableFileChangeTracking = true });
var points = await session.Rpc.Rewind.ListAsync();
await session.Rpc.Rewind.RewindAsync(new RewindRequest { RewindTarget = points[0].Id });
session = await client.create_session(enable_file_change_tracking=True)
points = await session.rpc.rewind.list()
await session.rpc.rewind.rewind(rewind_target=points[0].id)
Sessions now support expiry-aware GitHub token callbacks in addition to static tokens. The SDK handles refresh requests from the runtime, so extensions always receive fresh credentials. (#2412)
const session = await client.createSession({
gitHubTokenProvider: async ({ host, reason }) => ({ token: await fetchToken(host) })
});
var session = await client.CreateSessionAsync(new SessionOptions {
GitHubTokenProvider = async (req, ct) =>
new GitHubTokenResult { Token = await FetchTokenAsync(req.Host) }
});
session, _ := client.CreateSession(ctx, copilot.SessionOptions{
GitHubTokenProvider: func(ctx context.Context, req copilot.TokenProviderRequest) (copilot.TokenProviderResult, error) {
return copilot.TokenProviderResult{Token: fetchToken(req.Host)}, nil
},
})
The Java SDK now ships a bundled in-process Copilot CLI runtime for Linux x64/arm64, Windows x64/arm64, and Apple Silicon macOS. No separate CLI installation is needed on these platforms. (#2301, #2393, #2402, #2421, #2427)
The correct native classifier is resolved and loaded automatically at runtime — no configuration needed.
All six SDKs now spawn the dedicated copilot-runtime executable when managing their own subprocess connection, pairing the wrapper with the correct runtime.node addon for a leaner and more reliable process lifecycle. (#2395)
Host applications can now register trusted built-in plugin directories loaded before any session begins. Unlike ordinary --plugin-dir loading, these are registered via plugins.builtin.set and trusted by the host. (#2330)
const client = new CopilotClient({ builtinPluginDirectories: ['/path/to/plugins'] });
let client = CopilotClient::new(CopilotClientOptions {
builtin_plugin_directories: vec![PathBuf::from("/path/to/plugins")],
..Default::default()
});
Permission handlers can now attach optional decisionContext when replying to a permission request, letting the runtime attribute decisions to a person, host policy, or automated recommendation. Additive for all SDKs except Rust. (#2294)
session.onPermissionRequest(async (req) =>
createAttributedPermissionResult('approve_once', { source: 'policy' })
);
async def handler(req):
return copilot.create_attributed_permission_result('approve_once', {'source': 'policy'})
Rust breaking change:
PermissionResult::Decisionchanged from a tuple variant to a struct variant ({ decision, context }). Code using result helpers (approve_once()etc.) is unaffected; direct construction or pattern-matching onDecisionrequires migration.
joinSession() now accepts an env option listing the sensitive environment variable names the extension needs. The CLI prompts the user; on approval the values are written into process.env before joinSession resolves. (#2348)
const session = await host.joinSession(extensionId, { env: ['MY_API_KEY'] });
ClientMode::Empty now excludes built-in skills by defaultWhen a session is created in empty mode, includedBuiltinSkills defaults to [] across all SDKs. Pass an explicit allowlist to opt individual built-in skills back in. (#2410)
Three improvements to the Agent Factories API in the Node SDK:
argsSchema on a factory so the CLI validates arguments before a run starts (#2315)session.factory.runs.list() supports cursor-based pagination for browsing full run history (#2431)All SDKs expose an askUserVariant option on session create and resume for structured ask-user tool behavior. Omitting it preserves legacy behavior. (#2432)
@lutzroeder made their first contribution in #2330@aymenfurter made their first contribution in #2294@lukehoban made their first contribution in #2292@scordio made their first contribution in #2382@OllieinCanada made their first contribution in #2374Generated by Release Changelog Generator · sonnet46 44.1 AIC · ⌖ 6.59 AIC · ⊞ 8.1K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, version: 1.0.73, model: claude-sonnet-4.6, id: 33490271047, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/33490271047 -->
Sessions can now opt into file-change tracking and conversation rewind. When enableFileChangeTracking is enabled, the session records which files were
Sessions can now opt into file-change tracking and conversation rewind. When enableFileChangeTracking is enabled, the session records which files were changed during a conversation turn. You can then list pending rewind points, preview changes, and rewind the conversation history together with any tracked file modifications. (#2321)
const session = await client.createSession({ enableFileChangeTracking: true });
const points = await session.rpc.rewind.listPendingRewindPoints();
await session.rpc.rewind.rewind({ id: points[0].id });
var session = await client.CreateSessionAsync(new SessionOptions { EnableFileChangeTracking = true });
var points = await session.Rpc.Rewind.ListPendingRewindPointsAsync();
await session.Rpc.Rewind.RewindAsync(new RewindRequest { Id = points[0].Id });
session = await client.create_session(enable_file_change_tracking=True)
points = await session.rpc.rewind.list_pending_rewind_points()
await session.rpc.rewind.rewind(id=points[0].id)
Sessions now support a dynamic, expiry-aware GitHub token callback as an alternative to a static gitHubToken. The SDK maps each host request (with host, session, and reason context) to your callback, handling concurrent-session isolation automatically. (#2412)
const session = await client.createSession({
gitHubTokenProvider: async ({ host }) => ({ token: await getToken(host), expiresIn: 3600 }),
});
var session = await client.CreateSessionAsync(new SessionOptions
{
GitHubTokenProvider = async (req, ct) =>
new GitHubToken { Token = await GetTokenAsync(req.Host, ct), ExpiresIn = TimeSpan.FromHours(1) }
});
session, err := client.CreateSession(ctx, copilot.SessionOptions{
GitHubTokenProvider: func(ctx context.Context, req copilot.GitHubTokenRequest) (copilot.GitHubToken, error) {
return copilot.GitHubToken{Token: getToken(req.Host), ExpiresIn: 3600}, nil
},
})
Applications that ship their own built-in plugins can now register a trusted plugin directory at client startup. These plugins are registered with the runtime before any sessions are created, distinct from ordinary --plugin-dir loading. (#2330)
const client = new CopilotClient({ builtInPluginDirectories: ['/path/to/plugins'] });
let client = CopilotClient::builder()
.built_in_plugin_directories(vec![PathBuf::from("/path/to/plugins")])
.build()?;
Permission handlers can now attach a decisionContext so the runtime can attribute whether a decision came from a person, a host policy, or an automated recommendation. This is additive for TypeScript, C#, Go, Python, and Java. Rust clients that construct PermissionResult::Decision directly must migrate from the tuple variant to the new struct variant. (#2294)
session.onPermissionRequest(async (req) => {
return createAttributedPermissionResult('allow_once', { source: 'host-policy' });
});
session.on_permission_request(|req| async move {
PermissionResult::approve_once().with_context(DecisionContext { source: "host-policy".into() })
});
ClientMode::Empty now defaults to no built-in skillsWhen creating a session with ClientMode::Empty, built-in skills are now disabled by default. To opt specific skills in, supply an explicit includedBuiltinSkills allowlist. Custom skills via enableSkills and skillDirectories are unaffected. (#2410)
const session = await client.createSession({
clientMode: 'empty',
includedBuiltinSkills: ['grep'],
});
The Java SDK now ships a bundled native CLI runtime for Linux x64, Linux ARM64, Windows x64, Windows ARM64, and Apple Silicon macOS. Applications on these platforms no longer need a separately installed Copilot CLI binary. (#2301, #2393, #2402, #2421, #2427)
JsonValue, ctx.agent() forwards agent/reasoningEffort/contextTier (#2309)argsSchema so the CLI validates caller arguments before starting a run (#2315)askUserVariant session option for structured ask-user tool selection (#2432)@lutzroeder made their first contribution in #2330@aymenfurter made their first contribution in #2294@lukehoban made their first contribution in #2292@scordio made their first contribution in #2382@OllieinCanada made their first contribution in #2374Generated by Release Changelog Generator · sonnet46 42.5 AIC · ⌖ 6.48 AIC · ⊞ 8.1K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, version: 1.0.73, model: claude-sonnet-4.6, id: 33487883765, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/33487883765 -->
Sessions can now opt in to file-change tracking so that rewinding restores both conversation history and the files that were modified. Enable it with
Sessions can now opt in to file-change tracking so that rewinding restores both conversation history and the files that were modified. Enable it with the new enableFileChangeTracking session option. (#2321)
const session = await client.startSession({ enableFileChangeTracking: true });
var session = await client.StartSessionAsync(new SessionOptions { EnableFileChangeTracking = true });
session = await client.start_session(enable_file_change_tracking=True)
session, _ := client.StartSession(ctx, &copilot.SessionOptions{EnableFileChangeTracking: true})
Session session = client.startSession(new SessionOptions().setEnableFileChangeTracking(true)).get();
let session = client.start_session(SessionOptions { enable_file_change_tracking: Some(true), ..Default::default() }).await?;
Applications can now supply a dynamic GitHub token callback instead of a static gitHubToken string. The runtime calls the callback before each token use, so short-lived tokens stay fresh across long-running sessions. (#2412)
const session = await client.startSession({
gitHubTokenProvider: async ({ host, reason }) => ({ token: await fetchToken(host) })
});
var session = await client.StartSessionAsync(new SessionOptions
{
GitHubTokenProvider = async (request, ct) => new GitHubTokenResult(await FetchTokenAsync(request.Host))
});
async def token_provider(request):
return GitHubTokenResult(token=await fetch_token(request.host))
session = await client.start_session(github_token_provider=token_provider)
session, _ := client.StartSession(ctx, &copilot.SessionOptions{
GitHubTokenProvider: func(ctx context.Context, req copilot.GitHubTokenRequest) (copilot.GitHubTokenResult, error) {
return copilot.GitHubTokenResult{Token: fetchToken(req.Host)}, nil
},
})
session = client.startSession(new SessionOptions()
.setGitHubTokenProvider((req, ct) ->
CompletableFuture.completedFuture(new GitHubTokenResult(fetchToken(req.getHost()))))).get();
let session = client.start_session(SessionOptions {
github_token_provider: Some(Box::new(|req| Box::pin(async move { Ok(GitHubTokenResult { token: fetch_token(&req.host).await }) }))),
..Default::default()
}).await?;
The Java SDK now supports an in-process connection mode that loads the Copilot runtime as a native library via JNA, eliminating the need for a separate CLI child process. Add the platform-specific classifier JAR to your project and use RuntimeConnection.forInProcess(). (#2301, #2393, #2402, #2421, #2427)
CopilotClientOptions options = new CopilotClientOptions()
.setConnection(RuntimeConnection.forInProcess());
CopilotClient client = new CopilotClient(options);
client.start().get();
Host applications can now register a set of trusted, host-bundled plugin directories at startup. These directories are registered with plugins.builtin.set before any session is created. (#2330)
ClientMode.Empty defaults to no built-in skillsClientMode.Empty now deny-by-defaults includedBuiltinSkills to [], matching its deny-by-default behavior for all other built-in capabilities. Callers can still pass an explicit allowlist to opt in to specific runtime-bundled skills. (#2410)
Permission handlers can now attach decisionContext to let the runtime attribute decisions (human, policy, or automated recommendation). This is additive for TypeScript, Python, Go, C#, and Java. Rust clients that construct or match PermissionResult::Decision directly must migrate from the tuple variant to the new struct variant. (#2294)
return createAttributedPermissionResult(PermissionDecision.ApproveOnce, context);
PermissionResult::Decision { decision: PermissionDecision::ApproveOnce, context: Some(ctx) }
Node SDK extensions can now declare which sensitive environment variables they need. The CLI prompts the user and, on approval, injects the granted values before the extension starts. (#2348)
await joinSession({ env: ["MY_API_KEY", "MY_SECRET"] });
argsSchema declarationNode SDK factories can now declare an argsSchema so the CLI validates caller arguments before starting a run, saving credits and preventing confusing runtime errors. (#2315)
session.defineFactory("my-factory", { argsSchema: { type: "object", properties: { query: { type: "string" } } } }, async (ctx) => { ... });
ctx.agent() now forwards agent, reasoningEffort, and contextTier (#2309)Client is dropped (#2292)@lutzroeder made their first contribution in #2330@aymenfurter made their first contribution in #2294@lukehoban made their first contribution in #2292@scordio made their first contribution in #2382@OllieinCanada made their first contribution in #2374Generated by Release Changelog Generator · sonnet46 33.8 AIC · ⌖ 7.74 AIC · ⊞ 8.1K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, version: 1.0.73, model: claude-sonnet-4.6, id: 33159675752, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/33159675752 -->
ClientMode::Empty now applies deny-by-default isolation to runtime-bundled skills in addition to other built-in capabilities. includedBuiltinSkills de
ClientMode::Empty now disables built-in skills by defaultClientMode::Empty now applies deny-by-default isolation to runtime-bundled skills in addition to other built-in capabilities. includedBuiltinSkills defaults to [] in Empty mode; pass an explicit allowlist to re-enable specific skills. This behavior is consistent across all six SDKs. (#2410)
// Node — empty mode: built-in skills excluded by default
const session = await client.createSession({ mode: ClientMode.Empty });
// opt back in:
const session = await client.createSession({ mode: ClientMode.Empty, includedBuiltinSkills: ["edit"] });
// C#
var session = await client.CreateSessionAsync(new SessionOptions { Mode = ClientMode.Empty });
// opt back in:
var session = await client.CreateSessionAsync(new SessionOptions { Mode = ClientMode.Empty, IncludedBuiltinSkills = ["edit"] });
# Python
session = await client.create_session(mode=ClientMode.EMPTY)
# opt back in:
session = await client.create_session(mode=ClientMode.EMPTY, included_builtin_skills=["edit"])
// Go
session, err := client.CreateSession(ctx, copilot.SessionOptions{Mode: copilot.ClientModeEmpty})
// opt back in:
session, err := client.CreateSession(ctx, copilot.SessionOptions{Mode: copilot.ClientModeEmpty, IncludedBuiltinSkills: []string{"edit"}})
Generated by Release Changelog Generator · sonnet46 28.6 AIC · ⌖ 4.12 AIC · ⊞ 8.1K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, version: 1.0.73, model: claude-sonnet-4.6, id: 33008374598, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/33008374598 -->
Sessions can now opt into file-change tracking and rewind conversation history along with tracked file changes. Enable the new enableFileChangeTrackin
Sessions can now opt into file-change tracking and rewind conversation history along with tracked file changes. Enable the new enableFileChangeTracking session option to allow calling rewind later. (#2321)
const session = await client.createSession({ enableFileChangeTracking: true });
// later:
await session.rpc.conversation.rewind({ ...rewindPoint });
var session = await client.CreateSessionAsync(new SessionOptions { EnableFileChangeTracking = true });
session = await client.create_session(enable_file_change_tracking=True)
session, err := client.CreateSession(ctx, copilot.SessionOptions{EnableFileChangeTracking: true})
The Java SDK now ships platform-native classifier JARs that load the Copilot runtime directly in-process via JNA — no separate CLI child process required. Currently available for linux-x64, Windows x64, and Apple Silicon macOS. (#2301, #2393, #2402)
CopilotClientOptions options = new CopilotClientOptions()
.setConnection(RuntimeConnection.forInProcess());
CopilotClient client = new CopilotClient(options);
client.start().get();
Permission handlers can now attach decisionContext so the runtime can attribute whether a decision came from a person, host policy, or an automated recommendation. This is additive for Node, Python, Go, .NET, and Java. Rust clients that construct or match PermissionResult::Decision directly must migrate to the new struct variant. (#2294)
createAttributedPermissionResult(result, context)copilot.create_attributed_permission_result(result, context)copilot.NewAttributedPermissionResult(result, context)DecisionContext on the permission decisionPermissionRequestResult.approveOnce().setDecisionContext(context)PermissionResult::approve_once().with_context(context)Applications can now register a set of host-bundled plugin directories that are trusted unconditionally and loaded before any user session begins. (#2330)
joinSession() now accepts an env option listing the sensitive environment variable names an extension needs. The CLI prompts the user for approval; if granted, the values are written into the extension's process.env before the session resolves. (#2348)
await joinSession({ env: ['MY_API_KEY', 'MY_SECRET'] });
JsonValue, ctx.agent() forwards reasoningEffort and contextTier, resume error union narrowed to codes the runtime raises (#2309)argsSchema on FactoryMeta so the CLI can validate factory arguments before a run starts (#2315)@lutzroeder made their first contribution in #2330@aymenfurter made their first contribution in #2294@lukehoban made their first contribution in #2292@scordio made their first contribution in #2382@OllieinCanada made their first contribution in #2374Generated by Release Changelog Generator · sonnet46 36.8 AIC · ⌖ 4.91 AIC · ⊞ 8.1K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, version: 1.0.73, model: claude-sonnet-4.6, id: 32915205268, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/32915205268 -->
Sessions now support rewinding conversation history and tracked file changes. Enable file-change tracking when creating a session, then rewind to a pr
Sessions now support rewinding conversation history and tracked file changes. Enable file-change tracking when creating a session, then rewind to a previous checkpoint to discard later turns and restore file state. (#2321)
const session = await client.createSession({ enableFileChangeTracking: true });
const rewindPoints = await session.rpc.rewind.listRewindPoints();
await session.rpc.rewind.rewind({ rewindPointId: rewindPoints[0].rewindPointId });
session = await client.create_session(enable_file_change_tracking=True)
rewind_points = await session.rpc.rewind.list_rewind_points()
await session.rpc.rewind.rewind(rewind_point_id=rewind_points[0].rewind_point_id)
session, _ := client.CreateSession(ctx, &copilot.SessionOptions{EnableFileChangeTracking: true})
points, _ := session.RPC.Rewind.ListRewindPoints(ctx)
_ = session.RPC.Rewind.Rewind(ctx, &copilot.RewindRequest{RewindPointId: points[0].RewindPointId})
var session = await client.CreateSessionAsync(new SessionOptions { EnableFileChangeTracking = true });
var points = await session.Rpc.Rewind.ListRewindPointsAsync();
await session.Rpc.Rewind.RewindAsync(new RewindRequest { RewindPointId = points[0].RewindPointId });
SessionOptions options = new SessionOptions().setEnableFileChangeTracking(true);
var session = client.createSession(options).get();
var points = session.getRpc().getRewind().listRewindPoints().get();
session.getRpc().getRewind().rewind(new RewindRequest().setRewindPointId(points.get(0).getRewindPointId())).get();
let session = client.create_session(SessionOptions { enable_file_change_tracking: Some(true), ..Default::default() }).await?;
let points = session.rpc.rewind.list_rewind_points().await?;
session.rpc.rewind.rewind(RewindRequest { rewind_point_id: points[0].rewind_point_id.clone() }).await?;
The Java SDK now supports an in-process connection mode on linux-x64 that loads the Copilot runtime as a native library via JNA — no separate CLI child process required. Add the copilot-sdk-java-runtime classifier JAR for your platform alongside the core SDK JAR. (#2301)
CopilotClientOptions options = new CopilotClientOptions()
.setConnection(RuntimeConnection.forInProcess());
CopilotClient client = new CopilotClient(options);
client.start().get();
Permission handlers can now attach decisionContext so the runtime can attribute whether a decision came from a person, host policy, or an automated recommendation. This is additive for all SDKs. Note for Rust: PermissionResult::Decision changed from a tuple variant to a struct variant — callers that construct or match it directly must migrate. (#2294)
return createAttributedPermissionResult("allow_once", { source: "user" });
return copilot.create_attributed_permission_result("allow_once", context)
return copilot.NewAttributedPermissionResult("allow_once", context)
return new PermissionDecision { Result = "allow_once", DecisionContext = context };
return PermissionRequestResult.approveOnce().setDecisionContext(context);
return PermissionResult::Decision { decision: PermissionDecision::ApproveOnce, context: Some(ctx) };
Hosts can now register a trusted set of host-bundled plugin directories that are loaded before any session is created, distinct from user-managed --plugin-dir directories. (#2330)
Node extensions can now pass an env option to joinSession() listing the sensitive environment variable names they need. The CLI prompts the user for approval; if granted, the variables are written into the extension process before joinSession() resolves. (#2348)
await joinSession({ env: ["MY_SECRET_TOKEN", "API_KEY"] });
argsSchema supportFactoryMeta now exposes an optional argsSchema field so factory authors can declare the argument shape their factory expects. The CLI validates call arguments against the schema before starting a run, surfacing malformed calls early without consuming credits. (#2315)
session.defineFactory("my-factory", { argsSchema: { type: "object", properties: { query: { type: "string" } } } }, async (ctx) => { /* ... */ });
Client is dropped (#2292)FactoryResult/FactoryArguments now typed as JsonValue, ctx.agent() forwards reasoningEffort and contextTier, resume error union trimmed to real codes (#2309)@lutzroeder made their first contribution in #2330@aymenfurter made their first contribution in #2294@lukehoban made their first contribution in #2292Generated by Release Changelog Generator · sonnet46 37.7 AIC · ⌖ 5.53 AIC · ⊞ 8.1K
<!-- gh-aw-agentic-workflow: Release Changelog Generator, engine: copilot, version: 1.0.73, model: claude-sonnet-4.6, id: 32356756421, workflow_id: release-changelog, run: https://github.com/github/copilot-sdk/actions/runs/32356756421 -->
docs: correct the Python Customize Mode section IDs and action list by @examon in https://github.com/github/copilot-sdk/pull/2264
history.clearContext and Tool.isTerminal across all SDKs by @examon in https://github.com/github/copilot-sdk/pull/2129Full Changelog: https://github.com/github/copilot-sdk/compare/v1.0.9...v1.0.11
One column per month.