mirror of
https://github.com/github/awesome-copilot.git
synced 2026-03-23 09:35:13 +00:00
Align Copilot SDK documentation with permission handling requirements (#1107)
* Apply permission handler requirements across Copilot SDK docs Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Polish permission update formatting in SDK examples Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com> Agent-Logs-Url: https://github.com/jamesmontemagno/awesome-copilot/sessions/adf27a88-92f8-4ca6-b3fe-1204e3bb9963 * Fix review comments on SDK permission handling PR Address 5 review comments from PR #1103: 1. Fix invalid object literal syntax (stray comma) in resumeSession example in copilot-sdk-nodejs.instructions.md 2. Replace unused PermissionHandler import with actual usage in cookbook/copilot-sdk/python/recipe/ralph_loop.py (was using inline lambda instead) 3. Replace unused approveAll import with actual usage in cookbook/copilot-sdk/nodejs/recipe/ralph-loop.ts (was using inline handler instead) 4. Add missing PermissionHandler import to 4 Python code snippets in skills/copilot-sdk/SKILL.md that reference it without importing 5. Add missing approveAll import to 3 TypeScript code snippets in skills/copilot-sdk/SKILL.md that reference it without importing * Refactor session creation to improve code formatting and consistency across SDK examples * Fix formatting: split multi-property lines and put closing braces on own lines Address review comments on PR #1107: - Split OnPermissionRequest + Model onto separate lines in Go, C#, TypeScript - Put closing }); on its own line consistently across all examples - Fix indentation in SKILL.md Quick Start, CLI URL, Error Handling sections - Fix cookbook Go multiple-sessions and error-handling formatting - Fix ralph-loop.md TypeScript indentation --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jamesmontemagno <1676321+jamesmontemagno@users.noreply.github.com>
This commit is contained in:
@@ -65,6 +65,7 @@ Use `SessionConfig` for configuration:
|
||||
```csharp
|
||||
await using var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5",
|
||||
Streaming = true,
|
||||
Tools = [...],
|
||||
@@ -89,7 +90,11 @@ await using var session = await client.CreateSessionAsync(new SessionConfig
|
||||
### Resuming Sessions
|
||||
|
||||
```csharp
|
||||
var session = await client.ResumeSessionAsync(sessionId, new ResumeSessionConfig { ... });
|
||||
var session = await client.ResumeSessionAsync(sessionId, new ResumeSessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
### Session Operations
|
||||
@@ -178,6 +183,7 @@ Set `Streaming = true` in SessionConfig:
|
||||
```csharp
|
||||
var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5",
|
||||
Streaming = true
|
||||
});
|
||||
@@ -236,6 +242,7 @@ using System.ComponentModel;
|
||||
|
||||
var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5",
|
||||
Tools = [
|
||||
AIFunctionFactory.Create(
|
||||
@@ -268,6 +275,7 @@ When Copilot invokes a tool, the client automatically:
|
||||
```csharp
|
||||
var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5",
|
||||
SystemMessage = new SystemMessageConfig
|
||||
{
|
||||
@@ -287,6 +295,7 @@ var session = await client.CreateSessionAsync(new SessionConfig
|
||||
```csharp
|
||||
var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5",
|
||||
SystemMessage = new SystemMessageConfig
|
||||
{
|
||||
@@ -336,8 +345,16 @@ await session.SendAsync(new MessageOptions
|
||||
Sessions are independent and can run concurrently:
|
||||
|
||||
```csharp
|
||||
var session1 = await client.CreateSessionAsync(new SessionConfig { Model = "gpt-5" });
|
||||
var session2 = await client.CreateSessionAsync(new SessionConfig { Model = "claude-sonnet-4.5" });
|
||||
var session1 = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5",
|
||||
});
|
||||
var session2 = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "claude-sonnet-4.5",
|
||||
});
|
||||
|
||||
await session1.SendAsync(new MessageOptions { Prompt = "Hello from session 1" });
|
||||
await session2.SendAsync(new MessageOptions { Prompt = "Hello from session 2" });
|
||||
@@ -350,6 +367,7 @@ Use custom API providers via `ProviderConfig`:
|
||||
```csharp
|
||||
var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Provider = new ProviderConfig
|
||||
{
|
||||
Type = "openai",
|
||||
@@ -390,7 +408,7 @@ var state = client.State;
|
||||
```csharp
|
||||
try
|
||||
{
|
||||
var session = await client.CreateSessionAsync();
|
||||
var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });
|
||||
await session.SendAsync(new MessageOptions { Prompt = "Hello" });
|
||||
}
|
||||
catch (StreamJsonRpc.RemoteInvocationException ex)
|
||||
@@ -433,7 +451,7 @@ ALWAYS use `await using` for automatic disposal:
|
||||
|
||||
```csharp
|
||||
await using var client = new CopilotClient();
|
||||
await using var session = await client.CreateSessionAsync();
|
||||
await using var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });
|
||||
// Resources automatically cleaned up
|
||||
```
|
||||
|
||||
@@ -477,6 +495,7 @@ await client.StartAsync();
|
||||
|
||||
await using var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Model = "gpt-5"
|
||||
});
|
||||
|
||||
@@ -501,7 +520,7 @@ await done.Task;
|
||||
### Multi-Turn Conversation
|
||||
|
||||
```csharp
|
||||
await using var session = await client.CreateSessionAsync();
|
||||
await using var session = await client.CreateSessionAsync(new SessionConfig { OnPermissionRequest = PermissionHandler.ApproveAll });
|
||||
|
||||
async Task SendAndWait(string prompt)
|
||||
{
|
||||
@@ -532,6 +551,7 @@ await SendAndWait("What is its population?");
|
||||
```csharp
|
||||
var session = await client.CreateSessionAsync(new SessionConfig
|
||||
{
|
||||
OnPermissionRequest = PermissionHandler.ApproveAll,
|
||||
Tools = [
|
||||
AIFunctionFactory.Create(
|
||||
([Description("User ID")] string userId) => {
|
||||
|
||||
Reference in New Issue
Block a user