You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-3Lines changed: 8 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,10 @@ For a complete walkthrough, see the **[Getting Started Guide](./docs/getting-sta
30
30
31
31
Quick steps:
32
32
33
-
1.**Install the Copilot CLI:**
33
+
1.**(Optional) Install the Copilot CLI**
34
34
35
-
Follow the [Copilot CLI installation guide](https://docs.github.com/en/copilot/how-tos/set-up/install-copilot-cli) to install the CLI, or ensure `copilot` is available in your PATH.
35
+
For Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically and no separate installation is required.
36
+
For the Go SDK, install the CLI manually or ensure `copilot` is available in your PATH.
36
37
37
38
2.**Install your preferred SDK** using the commands above.
38
39
@@ -81,7 +82,11 @@ See the **[Authentication documentation](./docs/auth/index.md)** for details on
81
82
82
83
### Do I need to install the Copilot CLI separately?
83
84
84
-
Yes, the Copilot CLI must be installed separately. The SDKs communicate with the Copilot CLI in server mode to provide agent capabilities.
85
+
No — for Node.js, Python, and .NET SDKs, the Copilot CLI is bundled automatically as a dependency. You do not need to install it separately.
86
+
87
+
For Go SDK, you may still need to install the CLI manually.
88
+
89
+
Advanced: You can override the bundled CLI using `cliPath` or `cliUrl` if you want to use a custom CLI binary or connect to an external server.
Copy file name to clipboardExpand all lines: docs/features/mcp.md
+41Lines changed: 41 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -156,6 +156,47 @@ await using var session = await client.CreateSessionAsync(new SessionConfig
156
156
});
157
157
```
158
158
159
+
## Tool Configuration
160
+
161
+
You can control which tools are available to an MCP server using the `tools` field.
162
+
163
+
### Allow all tools
164
+
165
+
Use `"*"` to enable all tools provided by the MCP server:
166
+
167
+
```typescript
168
+
tools: ["*"]
169
+
```
170
+
171
+
---
172
+
173
+
### Allow specific tools
174
+
175
+
Provide a list of tool names to restrict access:
176
+
177
+
```typescript
178
+
tools: ["bash", "edit"]
179
+
```
180
+
181
+
Only the listed tools will be available to the agent.
182
+
183
+
---
184
+
185
+
### Disable all tools
186
+
187
+
Use an empty array to disable all tools:
188
+
189
+
```typescript
190
+
tools: []
191
+
```
192
+
193
+
---
194
+
195
+
### Notes
196
+
197
+
- The `tools` field defines which tools are allowed.
198
+
- There is no separate `allow` or `disallow` configuration — tool access is controlled directly through this list.
199
+
159
200
## Quick Start: Filesystem MCP Server
160
201
161
202
Here's a complete working example using the official [`@modelcontextprotocol/server-filesystem`](https://www.npmjs.com/package/@modelcontextprotocol/server-filesystem) MCP server:
Copy file name to clipboardExpand all lines: docs/setup/local-cli.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Local CLI Setup
2
2
3
-
Use the Copilot SDK with the CLI already signed in on your machine. This is the simplest configuration — zero auth code, zero infrastructure.
3
+
Use the Copilot SDK with a Copilot CLI instance signed in on your machine. Depending on the SDK, this may be a bundled CLI (included automatically) or a system-installed CLI available in your PATH. This is the simplest configuration — zero auth code, zero infrastructure.
4
4
5
5
**Best for:** Personal projects, prototyping, local development, learning the SDK.
6
6
7
7
## How It Works
8
8
9
-
When you install the Copilot CLI and sign in, your credentials are stored in the system keychain. The SDK automatically starts the CLI as a child process and uses those stored credentials.
9
+
When a Copilot CLI instance is available (either bundled with the SDK or installed on your system) and signed in, credentials are stored in the system keychain. The SDK automatically starts the CLI as a child process and uses those stored credentials.
10
10
11
11
```mermaid
12
12
flowchart LR
@@ -21,7 +21,7 @@ flowchart LR
21
21
```
22
22
23
23
**Key characteristics:**
24
-
- CLI is spawned automatically by the SDK (no setup needed)
24
+
- CLI is spawned automatically by the SDK (using a bundled CLI or a system-installed CLI if available)
25
25
- Authentication uses the signed-in user's credentials from the system keychain
26
26
- Communication happens over stdio (stdin/stdout) — no network ports
27
27
- Sessions are local to your machine
@@ -161,7 +161,7 @@ While defaults work great, you can customize the local setup:
161
161
162
162
```typescript
163
163
const client =newCopilotClient({
164
-
// Override CLI location (default: bundled with @github/copilot)
164
+
// Override CLI location (by default, the SDK uses a bundled CLI or resolves one from your system)
0 commit comments