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
@@ -16,7 +16,7 @@ You want users to be able to continue a conversation even after closing and reop
### Creating a session with a custom ID
```csharp
using GitHub.Copilot.SDK;
using GitHub.Copilot;
await using var client = new CopilotClient();
await client.StartAsync();
@@ -74,16 +74,34 @@ await client.DeleteSessionAsync("user-123-conversation");
### Getting session history
Retrieve all messages from a session:
Retrieve all events from a session:
```csharp
var messages = await session.GetMessagesAsync();
foreach (var msg in messages)
using GitHub.Copilot; // UserMessageEvent, AssistantMessageEvent, etc. live in this namespace
var events = await session.GetEventsAsync();
foreach (var evt in events)
{
Console.WriteLine($"[{msg.Type}] {msg.Data.Content}");
switch (evt)
{
case UserMessageEvent user:
Console.WriteLine($"[user] {user.Data.Content}");
break;
case AssistantMessageEvent assistant:
Console.WriteLine($"[assistant] {assistant.Data.Content}");
break;
default:
// Sessions can also contain other events (tool calls, tool results, system events).
Console.WriteLine($"[{evt.GetType().Name}]");
break;
}
}
```
> A session's event stream may include event kinds beyond user and assistant messages
> (for example tool calls, tool results, and system events). Handle the ones you care
> about and fall back to a default case so nothing is silently dropped.
## Best practices
1. **Use meaningful session IDs**: Include user ID or context in the session ID