Update .NET Copilot SDK cookbook for GitHub.Copilot.SDK 1.0 (#2021)

* Update .NET Copilot SDK cookbook for GitHub.Copilot.SDK 1.0

Align the dotnet copilot-sdk cookbook recipes and docs with the 1.0.1 release:

- Namespace GitHub.Copilot.SDK -> GitHub.Copilot

- MCP config uses Dictionary<string, McpServerConfig> + McpStdioServerConfig (drop Type discriminator)

- StopAsync no longer returns an error list; wrap graceful shutdown in try/catch

- GetMessagesAsync -> GetEventsAsync with event pattern matching

- LogLevel string -> CopilotLogLevel.Error enum

* Address PR review: clarify package/namespace, default event case, MCP stdio wording

- Note that the GitHub.Copilot.SDK package exposes the GitHub.Copilot namespace in each recipe

- Add a default case + note to the GetEventsAsync history example so other event kinds are not silently dropped

- Refine accessibility-report docs to describe a local stdio MCP server (McpStdioServerConfig via npx)

* Address re-review: add using for event types, note StopAsync throw behavior
This commit is contained in:
Jon Galloway
2026-06-16 21:13:20 -07:00
committed by GitHub
parent fae6a92c9d
commit 1140812aaa
14 changed files with 65 additions and 36 deletions
@@ -32,7 +32,7 @@ dotnet run recipe/accessibility-report.cs
```csharp
#:package GitHub.Copilot.SDK@*
using GitHub.Copilot.SDK;
using GitHub.Copilot;
// Create and start client
await using var client = new CopilotClient();
@@ -65,12 +65,11 @@ await using var session = await client.CreateSessionAsync(new SessionConfig
Model = "claude-opus-4.6",
Streaming = true,
OnPermissionRequest = PermissionHandler.ApproveAll,
McpServers = new Dictionary<string, object>()
McpServers = new Dictionary<string, McpServerConfig>()
{
["playwright"] =
new McpLocalServerConfig
new McpStdioServerConfig
{
Type = "local",
Command = "npx",
Args = ["@playwright/mcp@latest"],
Tools = ["*"]
@@ -195,7 +194,7 @@ if (generateTests == "y" || generateTests == "yes")
## How it works
1. **Playwright MCP server**: Configures a local MCP server running `@playwright/mcp` to provide browser automation tools
1. **Playwright MCP server**: Configures a local stdio MCP server (`McpStdioServerConfig`, launched via `npx`) running `@playwright/mcp` to provide browser automation tools
2. **Streaming output**: Uses `Streaming = true` and `AssistantMessageDeltaEvent` for real-time token-by-token output
3. **Accessibility snapshot**: Playwright's `browser_snapshot` tool captures the full accessibility tree of the page
4. **Structured report**: The prompt engineers a consistent WCAG-aligned report format with emoji severity indicators
@@ -205,15 +204,14 @@ if (generateTests == "y" || generateTests == "yes")
### MCP server configuration
The recipe configures a local MCP server that runs alongside the session:
The recipe configures a local stdio MCP server (`McpStdioServerConfig`, launched via `npx`) that runs alongside the session:
```csharp
OnPermissionRequest = PermissionHandler.ApproveAll,
McpServers = new Dictionary<string, object>()
McpServers = new Dictionary<string, McpServerConfig>()
{
["playwright"] = new McpLocalServerConfig
["playwright"] = new McpStdioServerConfig
{
Type = "local",
Command = "npx",
Args = ["@playwright/mcp@latest"],
Tools = ["*"]