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:
James Montemagno
GitHub
@@ -30,7 +30,7 @@ yarn add @github/copilot-sdk
|
||||
### Basic Client Setup
|
||||
|
||||
```typescript
|
||||
import { CopilotClient } from "@github/copilot-sdk";
|
||||
import { CopilotClient, approveAll } from "@github/copilot-sdk";
|
||||
|
||||
const client = new CopilotClient();
|
||||
await client.start();
|
||||
@@ -74,6 +74,7 @@ Use `SessionConfig` for configuration:
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
streaming: true,
|
||||
tools: [...],
|
||||
@@ -106,6 +107,7 @@ const session = await client.createSession({
|
||||
```typescript
|
||||
const session = await client.resumeSession("session-id", {
|
||||
tools: [myNewTool],
|
||||
onPermissionRequest: approveAll,
|
||||
});
|
||||
```
|
||||
|
||||
@@ -190,8 +192,9 @@ Set `streaming: true` in SessionConfig:
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
model: "gpt-5",
|
||||
streaming: true,
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
streaming: true,
|
||||
});
|
||||
```
|
||||
|
||||
@@ -243,7 +246,8 @@ Use `defineTool` for type-safe tool definitions:
|
||||
import { defineTool } from "@github/copilot-sdk";
|
||||
|
||||
const session = await client.createSession({
|
||||
model: "gpt-5",
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
tools: [
|
||||
defineTool({
|
||||
name: "lookup_issue",
|
||||
@@ -272,6 +276,7 @@ The SDK supports Zod schemas for parameters:
|
||||
import { z } from "zod";
|
||||
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
tools: [
|
||||
defineTool({
|
||||
name: "get_weather",
|
||||
@@ -316,7 +321,8 @@ When Copilot invokes a tool, the client automatically:
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
model: "gpt-5",
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
systemMessage: {
|
||||
mode: "append",
|
||||
content: `
|
||||
@@ -333,7 +339,8 @@ const session = await client.createSession({
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
model: "gpt-5",
|
||||
onPermissionRequest: approveAll,
|
||||
model: "gpt-5",
|
||||
systemMessage: {
|
||||
mode: "replace",
|
||||
content: "You are a helpful assistant.",
|
||||
@@ -377,8 +384,14 @@ await session.send({
|
||||
Sessions are independent and can run concurrently:
|
||||
|
||||
```typescript
|
||||
const session1 = await client.createSession({ model: "gpt-5" });
|
||||
const session2 = 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: "claude-sonnet-4.5",
|
||||
});
|
||||
|
||||
await Promise.all([
|
||||
session1.send({ prompt: "Hello from session 1" }),
|
||||
@@ -392,6 +405,7 @@ Use custom API providers via `provider`:
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
provider: {
|
||||
type: "openai",
|
||||
baseUrl: "https://api.openai.com/v1",
|
||||
@@ -422,7 +436,7 @@ await client.deleteSession(sessionId);
|
||||
```typescript
|
||||
const lastId = await client.getLastSessionId();
|
||||
if (lastId) {
|
||||
const session = await client.resumeSession(lastId);
|
||||
const session = await client.resumeSession(lastId, { onPermissionRequest: approveAll });
|
||||
}
|
||||
```
|
||||
|
||||
@@ -439,7 +453,7 @@ const state = client.getState();
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const session = await client.createSession();
|
||||
const session = await client.createSession({ onPermissionRequest: approveAll });
|
||||
await session.send({ prompt: "Hello" });
|
||||
} catch (error) {
|
||||
console.error(`Error: ${error.message}`);
|
||||
@@ -477,7 +491,7 @@ ALWAYS use try-finally or cleanup in a finally block:
|
||||
const client = new CopilotClient();
|
||||
try {
|
||||
await client.start();
|
||||
const session = await client.createSession();
|
||||
const session = await client.createSession({ onPermissionRequest: approveAll });
|
||||
try {
|
||||
// Use session...
|
||||
} finally {
|
||||
@@ -507,7 +521,7 @@ async function withSession<T>(
|
||||
client: CopilotClient,
|
||||
fn: (session: CopilotSession) => Promise<T>,
|
||||
): Promise<T> {
|
||||
const session = await client.createSession();
|
||||
const session = await client.createSession({ onPermissionRequest: approveAll });
|
||||
try {
|
||||
return await fn(session);
|
||||
} finally {
|
||||
@@ -542,13 +556,16 @@ await withClient(async (client) => {
|
||||
### Simple Query-Response
|
||||
|
||||
```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",
|
||||
});
|
||||
try {
|
||||
await new Promise<void>((resolve) => {
|
||||
session.on((event) => {
|
||||
@@ -572,7 +589,7 @@ try {
|
||||
### Multi-Turn Conversation
|
||||
|
||||
```typescript
|
||||
const session = await client.createSession();
|
||||
const session = await client.createSession({ onPermissionRequest: approveAll });
|
||||
|
||||
async function sendAndWait(prompt: string): Promise<void> {
|
||||
await new Promise<void>((resolve, reject) => {
|
||||
@@ -621,6 +638,7 @@ interface UserInfo {
|
||||
}
|
||||
|
||||
const session = await client.createSession({
|
||||
onPermissionRequest: approveAll,
|
||||
tools: [
|
||||
defineTool({
|
||||
name: "get_user",
|
||||
|
||||
Reference in New Issue
Block a user