Skip to content

Add Permission Handling documentation to all language READMEs #879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patniko merged 3 commits into from
Mar 18, 2026
Merged

Add Permission Handling documentation to all language READMEs #879

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55d2578
Add Permission Handling documentation to all language READMEs
Copilot Mar 17, 2026
7ce5033
Merge pull request #1 from jamesmontemagno/copilot/update-readmes-for…
jamesmontemagno Mar 17, 2026
bbd5acb
Apply suggestions from code review
jamesmontemagno Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
  • Loading branch information
@jamesmontemagno
jamesmontemagno and Copilot authored Mar 17, 2026
commit bbd5acb67a6a57fbbee4d6f032d30dea199c5b46
26 changes: 14 additions & 12 deletions dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -607,19 +607,21 @@ var session = await client.CreateSessionAsync(new SessionConfig
Model = "gpt-5",
OnPermissionRequest = async (request, invocation) =>
{
// request.Kind — what type of operation is being requested:
// PermissionRequestKind.Shell — executing a shell command
// PermissionRequestKind.Write — writing or editing a file
// PermissionRequestKind.Read — reading a file
// PermissionRequestKind.Mcp — calling an MCP tool
// PermissionRequestKind.CustomTool — calling one of your registered tools
// PermissionRequestKind.Url — fetching a URL
// request.ToolCallId — the tool call that triggered this request
// request.ToolName — name of the tool (for custom-tool / mcp)
// request.FileName — file being written (for write)
// request.Kind — string discriminator for the type of operation being requested:
// "shell" — executing a shell command
// "write" — writing or editing a file
// "read" — reading a file
// "mcp" — calling an MCP tool
// "custom_tool" — calling one of your registered tools
// "url" — fetching a URL
// "memory" — accessing or modifying assistant memory
// "hook" — invoking a registered hook
// request.ToolCallId — the tool call that triggered this request
// request.ToolName — name of the tool (for custom-tool / mcp)
// request.FileName — file being written (for write)
// request.FullCommandText — full shell command text (for shell)

if (request.Kind == PermissionRequestKind.Shell)
if (request.Kind == "shell")
{
// Deny shell commands
return new PermissionRequestResult { Kind = PermissionRequestResultKind.DeniedInteractivelyByUser };
Expand All @@ -638,7 +640,7 @@ var session = await client.CreateSessionAsync(new SessionConfig
| `PermissionRequestResultKind.DeniedInteractivelyByUser` | User explicitly denied the request |
| `PermissionRequestResultKind.DeniedCouldNotRequestFromUser` | No approval rule matched and user could not be asked |
| `PermissionRequestResultKind.DeniedByRules` | Denied by a policy rule |
| `PermissionRequestResultKind.NoResult` | No decision (treated as denied) |
| `PermissionRequestResultKind.NoResult` | Leave the permission request unanswered (the SDK returns without calling the RPC). Not allowed for protocol v2 permission requests (will be rejected). |

### Resuming Sessions

Expand Down
4 changes: 3 additions & 1 deletion go/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,8 @@ session, err := client.CreateSession(context.Background(), &copilot.SessionConfi
// copilot.MCP — calling an MCP tool
// copilot.CustomTool — calling one of your registered tools
// copilot.URL — fetching a URL
Comment thread
jamesmontemagno marked this conversation as resolved.
// copilot.Memory — accessing or updating Copilot-managed memory
// copilot.Hook — invoking a registered hook
// request.ToolCallID — pointer to the tool call that triggered this request
// request.ToolName — pointer to the name of the tool (for custom-tool / mcp)
// request.FileName — pointer to the file being written (for write)
Expand All @@ -555,7 +557,7 @@ session, err := client.CreateSession(context.Background(), &copilot.SessionConfi
| `PermissionRequestResultKindDeniedInteractivelyByUser` | User explicitly denied the request |
| `PermissionRequestResultKindDeniedCouldNotRequestFromUser` | No approval rule matched and user could not be asked |
| `PermissionRequestResultKindDeniedByRules` | Denied by a policy rule |
| `PermissionRequestResultKindNoResult` | No decision (treated as denied) |
| `PermissionRequestResultKindNoResult` | Leave the permission request unanswered (protocol v1 only; not allowed for protocol v2) |

### Resuming Sessions

Expand Down
5 changes: 4 additions & 1 deletion nodejs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,9 @@ const session = await client.createSession({
// "mcp" — calling an MCP tool
// "custom-tool" — calling one of your registered tools
// "url" — fetching a URL
Comment thread
jamesmontemagno marked this conversation as resolved.
// "memory" — storing or retrieving persistent session memory
// "hook" — invoking a server-side hook or integration
// (additional kinds may be added; include a default case in handlers)
// request.toolCallId — the tool call that triggered this request
// request.toolName — name of the tool (for custom-tool / mcp)
// request.fileName — file being written (for write)
Expand All @@ -708,7 +711,7 @@ const session = await client.createSession({
| `"denied-no-approval-rule-and-could-not-request-from-user"` | No approval rule matched and user could not be asked |
| `"denied-by-rules"` | Denied by a policy rule |
| `"denied-by-content-exclusion-policy"` | Denied due to a content exclusion policy |

| `"no-result"` | Leave the request unanswered (only valid with protocol v1; rejected by protocol v2 servers) |
### Resuming Sessions

Pass `onPermissionRequest` when resuming a session too — it is required:
Expand Down
3 changes: 3 additions & 0 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,8 @@ def on_permission_request(request: PermissionRequest, invocation: dict) -> Permi
# "mcp" — calling an MCP tool
# "custom-tool" — calling one of your registered tools
# "url" — fetching a URL
Comment thread
jamesmontemagno marked this conversation as resolved.
# "memory" — accessing or updating session/workspace memory
# "hook" — invoking a registered hook
# request.tool_call_id — the tool call that triggered this request
# request.tool_name — name of the tool (for custom-tool / mcp)
# request.file_name — file being written (for write)
Expand Down Expand Up @@ -543,6 +545,7 @@ async def on_permission_request(request: PermissionRequest, invocation: dict) ->
| `"denied-no-approval-rule-and-could-not-request-from-user"` | No approval rule matched and user could not be asked (default when no kind is specified) |
| `"denied-by-rules"` | Denied by a policy rule |
| `"denied-by-content-exclusion-policy"` | Denied due to a content exclusion policy |
Comment thread
jamesmontemagno marked this conversation as resolved.
| `"no-result"` | Leave the request unanswered (not allowed for protocol v2 permission requests) |

### Resuming Sessions

Expand Down