Skip to content

Commit 6f6b0fe

Browse files
authored
Merge pull request #33 from copilot-community-sdk/docs/add-task-complete-custom-tool-kinds-89d11169fa16a9de
[docs] Update documentation for features from 2026-02-26
2 parents 8a58b08 + 762706e commit 6f6b0fe

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ All notable changes to this project will be documented in this file. This change
1717

1818
### Added (documentation)
1919
- Microsoft Foundry Local BYOK provider guide in `doc/auth/byok.md`: quick start example, installation instructions, and connection troubleshooting (upstream PR #461).
20+
- `doc/reference/API.md`: added `:copilot/session.task_complete` to the Event Reference table (from upstream PR #544 sync).
21+
- `doc/reference/API.md`: added permission kind reference table (`:shell`, `:write`, `:mcp`, `:read`, `:url`, `:custom-tool`) in the Permission Handling section.
2022

2123
### Added (upstream PR #329 sync)
2224
- Windows console window hiding: CLI process is spawned with explicit PIPE redirects ensuring the JVM sets `CREATE_NO_WINDOW` on Windows — no console window appears in GUI applications. Equivalent to upstream `windowsHide: true` (upstream PR #329).

doc/reference/API.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -885,6 +885,7 @@ copilot/tool-events
885885
| `:copilot/hook.start` | Hook invocation started |
886886
| `:copilot/hook.end` | Hook invocation finished |
887887
| `:copilot/system.message` | System message emitted |
888+
| `:copilot/session.task_complete` | Task completed by the session agent |
888889

889890
### Example: Handling Events
890891

@@ -1170,6 +1171,17 @@ Use `approve-all` to opt into approving everything:
11701171
{:on-permission-request copilot/approve-all}))
11711172
```
11721173

1174+
The `:permission-kind` field in permission requests identifies the type of action requiring approval:
1175+
1176+
| Permission Kind | Description |
1177+
|----------------|-------------|
1178+
| `:shell` | Shell command execution |
1179+
| `:write` | File system write operation |
1180+
| `:mcp` | MCP tool invocation |
1181+
| `:read` | File system read operation |
1182+
| `:url` | URL fetch / HTTP request |
1183+
| `:custom-tool` | SDK-registered custom tool invocation |
1184+
11731185
For fine-grained control, provide your own handler. When the CLI needs
11741186
approval, it sends a JSON-RPC `permission.request` to the SDK. Your
11751187
`:on-permission-request` callback must return a map compatible with the

0 commit comments

Comments
 (0)