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:
James Montemagno
2026-03-22 17:11:19 -07:00
committed by GitHub
parent 6d48c08215
commit 33f544c71d
48 changed files with 376 additions and 143 deletions

View File

@@ -35,7 +35,7 @@ npx tsx accessibility-report.ts
```typescript
#!/usr/bin/env npx tsx
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
import * as readline from "node:readline";
// ============================================================================
@@ -73,6 +73,7 @@ async function main() {
const client = new CopilotClient();
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "claude-opus-4.6",
streaming: true,
mcpServers: {
@@ -191,6 +192,7 @@ The recipe configures a local MCP server that runs alongside the session:
```typescript
const session = await client.createSession({
onPermissionRequest: approveAll,
mcpServers: {
playwright: {
type: "local",

View File

@@ -17,13 +17,16 @@ You need to handle various error conditions like connection failures, timeouts,
## Basic try-catch
```typescript
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
const client = new CopilotClient();
try {
await client.start();
const session = await client.createSession({ model: "gpt-5" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
const response = await session.sendAndWait({ prompt: "Hello!" });
console.log(response?.data.content);
@@ -55,7 +58,10 @@ try {
## Timeout handling
```typescript
const session = await client.createSession({ model: "gpt-5" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
try {
// sendAndWait with timeout (in milliseconds)
@@ -79,7 +85,10 @@ try {
## Aborting a request
```typescript
const session = await client.createSession({ model: "gpt-5" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
// Start a request
session.send({ prompt: "Write a very long story..." });

View File

@@ -17,7 +17,7 @@ You have a folder with many files and want to organize them into subfolders base
## Example code
```typescript
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
import * as os from "node:os";
import * as path from "node:path";
@@ -27,6 +27,7 @@ await client.start();
// Create session
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});

View File

@@ -17,15 +17,24 @@ You need to run multiple conversations in parallel, each with its own context an
## Node.js
```typescript
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
const client = new CopilotClient();
await client.start();
// Create multiple independent sessions
const session1 = await client.createSession({ model: "gpt-5" });
const session2 = await client.createSession({ model: "gpt-5" });
const session3 = await client.createSession({ model: "claude-sonnet-4.5" });
const session1 = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
const session2 = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
const session3 = await client.createSession({
onPermissionRequest: approveAll,
model: "claude-sonnet-4.5",
});
// Each session maintains its own conversation history
await session1.sendAndWait({ prompt: "You are helping with a Python project" });
@@ -50,6 +59,7 @@ Use custom IDs for easier tracking:
```typescript
const session = await client.createSession({
onPermissionRequest: approveAll,
sessionId: "user-123-chat",
model: "gpt-5",
});

View File

@@ -17,13 +17,14 @@ You want users to be able to continue a conversation even after closing and reop
### Creating a session with a custom ID
```typescript
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
const client = new CopilotClient();
await client.start();
// Create session with a memorable ID
const session = await client.createSession({
onPermissionRequest: approveAll,
sessionId: "user-123-conversation",
model: "gpt-5",
});
@@ -45,7 +46,7 @@ const client = new CopilotClient();
await client.start();
// Resume the previous session
const session = await client.resumeSession("user-123-conversation");
const session = await client.resumeSession("user-123-conversation", { onPermissionRequest: approveAll });
// Previous context is restored
await session.sendAndWait({ prompt: "What were we discussing?" });

View File

@@ -42,7 +42,7 @@ npx tsx pr-visualization.ts --repo github/copilot-sdk
import { execSync } from "node:child_process";
import * as readline from "node:readline";
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
// ============================================================================
// Git & GitHub Detection
@@ -138,6 +138,7 @@ async function main() {
const client = new CopilotClient({ logLevel: "error" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
systemMessage: {
content: `

View File

@@ -43,7 +43,7 @@ The minimal Ralph loop — the SDK equivalent of `while :; do cat PROMPT.md | co
```typescript
import { readFile } from "fs/promises";
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
async function ralphLoop(promptFile: string, maxIterations: number = 50) {
const client = new CopilotClient();
@@ -56,7 +56,10 @@ async function ralphLoop(promptFile: string, maxIterations: number = 50) {
console.log(`\n=== Iteration ${i}/${maxIterations} ===`);
// Fresh session each iteration — context isolation is the point
const session = await client.createSession({ model: "gpt-5.1-codex-mini" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5.1-codex-mini",
});
try {
await session.sendAndWait({ prompt }, 600_000);
} finally {

View File

@@ -1,6 +1,6 @@
#!/usr/bin/env tsx
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
import * as readline from "node:readline";
// ============================================================================
@@ -38,6 +38,7 @@ async function main() {
const client = new CopilotClient();
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "claude-opus-4.6",
streaming: true,
mcpServers: {

View File

@@ -1,10 +1,13 @@
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
const client = new CopilotClient();
try {
await client.start();
const session = await client.createSession({ model: "gpt-5" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
const response = await session.sendAndWait({ prompt: "Hello!" });
console.log(response?.data.content);

View File

@@ -1,4 +1,4 @@
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
import * as os from "node:os";
import * as path from "node:path";
@@ -8,6 +8,7 @@ await client.start();
// Create session
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});

View File

@@ -1,12 +1,21 @@
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
const client = new CopilotClient();
await client.start();
// Create multiple independent sessions
const session1 = await client.createSession({ model: "gpt-5" });
const session2 = await client.createSession({ model: "gpt-5" });
const session3 = await client.createSession({ model: "claude-sonnet-4.5" });
const session1 = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
const session2 = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
});
const session3 = await client.createSession({
onPermissionRequest: approveAll,
model: "claude-sonnet-4.5",
});
console.log("Created 3 independent sessions");

View File

@@ -1,10 +1,11 @@
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
const client = new CopilotClient();
await client.start();
// Create a session with a memorable ID
const session = await client.createSession({
onPermissionRequest: approveAll,
sessionId: "user-123-conversation",
model: "gpt-5",
});
@@ -17,7 +18,7 @@ await session.destroy();
console.log("Session destroyed (state persisted)");
// Resume the previous session
const resumed = await client.resumeSession("user-123-conversation");
const resumed = await client.resumeSession("user-123-conversation", { onPermissionRequest: approveAll });
console.log(`Resumed: ${resumed.sessionId}`);
await resumed.sendAndWait({ prompt: "What were we discussing?" });

View File

@@ -1,6 +1,6 @@
#!/usr/bin/env tsx
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
import { execSync } from "node:child_process";
import * as readline from "node:readline";
@@ -98,6 +98,7 @@ async function main() {
const client = new CopilotClient({ logLevel: "error" });
const session = await client.createSession({
onPermissionRequest: approveAll,
model: "gpt-5",
systemMessage: {
content: `

View File

@@ -1,5 +1,5 @@
import { readFile } from "fs/promises";
import { CopilotClient } from "@github/copilot-sdk";
import { CopilotClient, approveAll } from "@github/copilot-sdk";
/**
* Ralph loop: autonomous AI task loop with fresh context per iteration.
@@ -44,7 +44,7 @@ async function ralphLoop(mode: Mode, maxIterations: number) {
// Pin the agent to the project directory
workingDirectory: process.cwd(),
// Auto-approve tool calls for unattended operation
onPermissionRequest: async () => ({ allow: true }),
onPermissionRequest: approveAll,
});
// Log tool usage for visibility