Skip to content

Commit 508d863

Browse files
GitHub CopilotCopilot
authored andcommitted
docs: add permissions and :client-name to getting-started What's Next
Add two missing topics to doc/getting-started.md: - Permission model: explain deny-by-default, show approve-all usage, link to Permission Handling section in API Reference - :client-name option: show how to identify an application in session config Both features were added in merged PRs (#18 and #21) but were not reflected in the getting-started tutorial. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 5fd2473 commit 508d863

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

doc/getting-started.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,6 +251,32 @@ Now that you have the basics, explore these topics:
251251
- **[MCP Servers](./mcp/overview.md)** — Connect to external tools via MCP
252252
- **[Examples](../examples/README.md)** — More working examples
253253

254+
### Permissions (deny-by-default)
255+
256+
The SDK uses a **deny-by-default** permission model. When Copilot requests permission
257+
to run shell commands, write files, or fetch URLs, the SDK denies all requests unless
258+
you provide an `:on-permission-request` handler.
259+
260+
Use `approve-all` to permit everything:
261+
262+
```clojure
263+
(copilot/with-client-session [session {:model "gpt-5.2"
264+
:on-permission-request copilot/approve-all}]
265+
...)
266+
```
267+
268+
Or write a custom handler for fine-grained control. See [Permission Handling](./reference/API.md#permission-handling) in the API Reference.
269+
270+
### Identifying Your Application
271+
272+
Pass `:client-name` to identify your application in API requests (included in the User-Agent header):
273+
274+
```clojure
275+
(copilot/with-client-session [session {:model "gpt-5.2"
276+
:client-name "my-weather-app"}]
277+
...)
278+
```
279+
254280
### Key Concepts
255281

256282
| Concept | Description |

0 commit comments

Comments
 (0)