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,8 +35,11 @@ python accessibility_report.py
import asyncio
from copilot import (
CopilotClient, SessionConfig, MessageOptions,
CopilotClient,
SessionConfig,
MessageOptions,
SessionEvent,
PermissionHandler,
)
# ============================================================================
@@ -74,7 +77,7 @@ async def main():
"tools": ["*"],
}
},
))
on_permission_request=PermissionHandler.approve_all))
done = asyncio.Event()
@@ -187,7 +190,7 @@ session = await client.create_session(SessionConfig(
"tools": ["*"],
}
},
))
on_permission_request=PermissionHandler.approve_all))
```
This gives the model access to Playwright browser tools like `browser_navigate`, `browser_snapshot`, and `browser_click`.

View File

@@ -17,14 +17,15 @@ You need to handle various error conditions like connection failures, timeouts,
```python
import asyncio
from copilot import CopilotClient, SessionConfig, MessageOptions
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
async def main():
client = CopilotClient()
try:
await client.start()
session = await client.create_session(SessionConfig(model="gpt-5"))
session = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
response = await session.send_and_wait(MessageOptions(prompt="Hello!"))
@@ -57,7 +58,8 @@ except Exception as e:
## Timeout handling
```python
session = await client.create_session(SessionConfig(model="gpt-5"))
session = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
try:
# send_and_wait accepts an optional timeout in seconds
@@ -73,7 +75,8 @@ except TimeoutError:
## Aborting a request
```python
session = await client.create_session(SessionConfig(model="gpt-5"))
session = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
# Start a request (non-blocking send)
await session.send(MessageOptions(prompt="Write a very long story..."))

View File

@@ -19,8 +19,11 @@ You have a folder with many files and want to organize them into subfolders base
import asyncio
import os
from copilot import (
CopilotClient, SessionConfig, MessageOptions,
CopilotClient,
SessionConfig,
MessageOptions,
SessionEvent,
PermissionHandler,
)
async def main():
@@ -29,7 +32,8 @@ async def main():
await client.start()
# Create session
session = await client.create_session(SessionConfig(model="gpt-5"))
session = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
done = asyncio.Event()

View File

@@ -17,16 +17,19 @@ You need to run multiple conversations in parallel, each with its own context an
```python
import asyncio
from copilot import CopilotClient, SessionConfig, MessageOptions
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
async def main():
client = CopilotClient()
await client.start()
# Create multiple independent sessions
session1 = await client.create_session(SessionConfig(model="gpt-5"))
session2 = await client.create_session(SessionConfig(model="gpt-5"))
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5"))
session1 = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
session2 = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5",
on_permission_request=PermissionHandler.approve_all))
# Each session maintains its own conversation history
await session1.send(MessageOptions(prompt="You are helping with a Python project"))
@@ -55,8 +58,8 @@ Use custom IDs for easier tracking:
```python
session = await client.create_session(SessionConfig(
session_id="user-123-chat",
model="gpt-5"
))
model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
print(session.session_id) # "user-123-chat"
```

View File

@@ -17,7 +17,7 @@ You want users to be able to continue a conversation even after closing and reop
```python
import asyncio
from copilot import CopilotClient, SessionConfig, MessageOptions
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
async def main():
client = CopilotClient()
@@ -27,7 +27,7 @@ async def main():
session = await client.create_session(SessionConfig(
session_id="user-123-conversation",
model="gpt-5",
))
on_permission_request=PermissionHandler.approve_all))
await session.send_and_wait(MessageOptions(prompt="Let's discuss TypeScript generics"))
@@ -49,7 +49,7 @@ client = CopilotClient()
await client.start()
# Resume the previous session
session = await client.resume_session("user-123-conversation")
session = await client.resume_session("user-123-conversation", on_permission_request=PermissionHandler.approve_all)
# Previous context is restored
await session.send_and_wait(MessageOptions(prompt="What were we discussing?"))

View File

@@ -44,8 +44,11 @@ import sys
import os
import re
from copilot import (
CopilotClient, SessionConfig, MessageOptions,
CopilotClient,
SessionConfig,
MessageOptions,
SessionEvent,
PermissionHandler,
)
# ============================================================================
@@ -150,8 +153,8 @@ The current working directory is: {os.getcwd()}
- Be concise in your responses
</instructions>
"""
}
))
},
on_permission_request=PermissionHandler.approve_all))
done = asyncio.Event()

View File

@@ -48,7 +48,7 @@ The minimal Ralph loop — the SDK equivalent of `while :; do cat PROMPT.md | co
```python
import asyncio
from pathlib import Path
from copilot import CopilotClient, MessageOptions, SessionConfig
from copilot import CopilotClient, MessageOptions, SessionConfig, PermissionHandler
async def ralph_loop(prompt_file: str, max_iterations: int = 50):
@@ -63,7 +63,8 @@ async def ralph_loop(prompt_file: str, max_iterations: int = 50):
# Fresh session each iteration — context isolation is the point
session = await client.create_session(
SessionConfig(model="gpt-5.1-codex-mini")
SessionConfig(model="gpt-5.1-codex-mini",
on_permission_request=PermissionHandler.approve_all)
)
try:
await session.send_and_wait(

View File

@@ -2,8 +2,11 @@
import asyncio
from copilot import (
CopilotClient, SessionConfig, MessageOptions,
CopilotClient,
SessionConfig,
MessageOptions,
SessionEvent,
PermissionHandler,
)
# ============================================================================
@@ -41,7 +44,7 @@ async def main():
"tools": ["*"],
}
},
))
on_permission_request=PermissionHandler.approve_all))
done = asyncio.Event()

View File

@@ -1,14 +1,15 @@
#!/usr/bin/env python3
import asyncio
from copilot import CopilotClient, SessionConfig, MessageOptions
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
async def main():
client = CopilotClient()
try:
await client.start()
session = await client.create_session(SessionConfig(model="gpt-5"))
session = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
response = await session.send_and_wait(MessageOptions(prompt="Hello!"))

View File

@@ -3,8 +3,11 @@
import asyncio
import os
from copilot import (
CopilotClient, SessionConfig, MessageOptions,
CopilotClient,
SessionConfig,
MessageOptions,
SessionEvent,
PermissionHandler,
)
async def main():
@@ -13,7 +16,8 @@ async def main():
await client.start()
# Create session
session = await client.create_session(SessionConfig(model="gpt-5"))
session = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
done = asyncio.Event()

View File

@@ -1,16 +1,19 @@
#!/usr/bin/env python3
import asyncio
from copilot import CopilotClient, SessionConfig, MessageOptions
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
async def main():
client = CopilotClient()
await client.start()
# Create multiple independent sessions
session1 = await client.create_session(SessionConfig(model="gpt-5"))
session2 = await client.create_session(SessionConfig(model="gpt-5"))
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5"))
session1 = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
session2 = await client.create_session(SessionConfig(model="gpt-5",
on_permission_request=PermissionHandler.approve_all))
session3 = await client.create_session(SessionConfig(model="claude-sonnet-4.5",
on_permission_request=PermissionHandler.approve_all))
print("Created 3 independent sessions")

View File

@@ -1,7 +1,7 @@
#!/usr/bin/env python3
import asyncio
from copilot import CopilotClient, SessionConfig, MessageOptions
from copilot import CopilotClient, SessionConfig, MessageOptions, PermissionHandler
async def main():
client = CopilotClient()
@@ -11,7 +11,7 @@ async def main():
session = await client.create_session(SessionConfig(
session_id="user-123-conversation",
model="gpt-5",
))
on_permission_request=PermissionHandler.approve_all))
await session.send_and_wait(MessageOptions(prompt="Let's discuss TypeScript generics"))
print(f"Session created: {session.session_id}")
@@ -21,7 +21,7 @@ async def main():
print("Session destroyed (state persisted)")
# Resume the previous session
resumed = await client.resume_session("user-123-conversation")
resumed = await client.resume_session("user-123-conversation", on_permission_request=PermissionHandler.approve_all)
print(f"Resumed: {resumed.session_id}")
await resumed.send_and_wait(MessageOptions(prompt="What were we discussing?"))

View File

@@ -6,8 +6,11 @@ import sys
import os
import re
from copilot import (
CopilotClient, SessionConfig, MessageOptions,
CopilotClient,
SessionConfig,
MessageOptions,
SessionEvent,
PermissionHandler,
)
# ============================================================================
@@ -112,8 +115,8 @@ The current working directory is: {os.getcwd()}
- Be concise in your responses
</instructions>
"""
}
))
},
on_permission_request=PermissionHandler.approve_all))
done = asyncio.Event()

View File

@@ -22,7 +22,7 @@ import asyncio
import sys
from pathlib import Path
from copilot import CopilotClient, MessageOptions, SessionConfig
from copilot import CopilotClient, MessageOptions, SessionConfig, PermissionHandler
async def ralph_loop(mode: str = "build", max_iterations: int = 50):
@@ -48,10 +48,7 @@ async def ralph_loop(mode: str = "build", max_iterations: int = 50):
# Pin the agent to the project directory
working_directory=str(Path.cwd()),
# Auto-approve tool calls for unattended operation
on_permission_request=lambda _req, _ctx: {
"kind": "approved",
"rules": [],
},
on_permission_request=PermissionHandler.approve_all,
))
# Log tool usage for visibility