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: docs/src/content/docs/reference/engines.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ engine:
38
38
#### Required Secrets
39
39
40
40
- **`COPILOT_GITHUB_TOKEN`**: GitHub Personal Access Token (PAT) with "Copilot Requests" permission
41
-
- **`GH_AW_GITHUB_TOKEN`** (optional): Required for [GitHub Tools Remote Mode](/gh-aw/reference/tools/#github-remote-mode)
41
+
- **`GH_AW_GITHUB_TOKEN`** (optional): Required for [GitHub Tools Remote Mode](/gh-aw/reference/tools/#modes-and-restrictions)
42
42
43
43
#### Authenticating with a Personal Access Token (PAT)
44
44
@@ -166,7 +166,7 @@ engine:
166
166
#### Required Secrets
167
167
168
168
- **`CLAUDE_CODE_OAUTH_TOKEN`** or **`ANTHROPIC_API_KEY`**: Authentication token for Claude Code. Both secrets are passed to the CLI if configured, and the CLI determines which to use (with `CLAUDE_CODE_OAUTH_TOKEN` taking precedence)
169
-
- **`GH_AW_GITHUB_TOKEN`** (optional): Required for [GitHub Tools Remote Mode](/gh-aw/reference/tools/#github-remote-mode)
169
+
- **`GH_AW_GITHUB_TOKEN`** (optional): Required for [GitHub Tools Remote Mode](/gh-aw/reference/tools/#modes-and-restrictions)
toolsets: [repos, issues, pull_requests] # Toolset groups
96
68
```
97
69
98
70
### GitHub Toolsets
99
71
100
72
:::tip[Prefer Toolsets Over Individual Tools]
101
-
Use `toolsets:` to enable groups of related tools instead of listing individual tools with `allowed:`. Toolsets provide better organization, reduce configuration verbosity, and ensure you get all related functionality.
73
+
Use `toolsets:` to enable groups of related tools instead of listing individual tools with `allowed:`. Toolsets reduce configuration verbosity and ensure complete functionality.
102
74
:::
103
75
104
-
Enables or disables specific GitHub API groups to improve tool selection and reduce context size.
76
+
Enable specific GitHub API groups to improve tool selection and reduce context size:
Both `toolsets:` and `allowed:` can be used together. When specified, `allowed:` further restricts which tools are available within the enabled toolsets.
175
-
:::
95
+
#### Toolset Contents
96
+
97
+
Common toolsets include:
98
+
- **context**: User/team info (`get_me`, `get_teams`, `get_team_members`)
- **actions**: Workflows and runs (`list_workflows`, `list_workflow_runs`, `get_workflow_run`, artifacts)
103
+
- **code_security**: Security scanning alerts
104
+
- **discussions**: GitHub Discussions
105
+
- **labels**: Label management
176
106
177
-
**Supported Modes**: Toolsets are supported in both local (Docker) and remote (hosted) modes.
107
+
Combine `toolsets:` with `allowed:` to further restrict available tools within enabled toolsets. Toolsets work in both local (Docker) and remote (hosted) modes.
178
108
179
-
### GitHub Remote Mode
109
+
### Modes and Restrictions
180
110
181
-
Uses the hosted GitHub MCP server at `https://api.githubcopilot.com/mcp/` for faster startup without Docker.
111
+
**Remote Mode**: Use the hosted GitHub MCP server for faster startup without Docker. Requires setting `GH_AW_GITHUB_TOKEN` secret (standard `GITHUB_TOKEN` not supported):
182
112
183
113
```yaml wrap
184
114
tools:
185
115
github:
186
-
mode: remote
187
-
allowed: [list_issues, create_issue]
116
+
mode: remote # Default is "local" (Docker)
188
117
```
189
118
190
-
**Setup**: Create a Personal Access Token and set the `GH_AW_GITHUB_TOKEN` secret:
119
+
Setup: `gh secret set GH_AW_GITHUB_TOKEN -a actions --body "<your-pat>"`
191
120
192
-
```bash wrap
193
-
gh secret set GH_AW_GITHUB_TOKEN -a actions --body "<your-github-pat>"
194
-
```
195
-
196
-
**Note**: Remote mode requires `GH_AW_GITHUB_TOKEN` (standard `GITHUB_TOKEN` is not supported).
**Domain Access**: Uses same ecosystem bundles as `network:` configuration (`defaults`, `github`, `node`, `python`, etc.). Default: `["localhost", "127.0.0.1"]` for security.
223
-
224
-
```yaml wrap
225
-
playwright:
226
-
allowed_domains:
227
-
- "defaults" # Basic infrastructure
228
-
- "github" # GitHub domains
229
-
- "*.example.com" # Custom wildcard
230
-
```
139
+
**Domain Access**: Uses same ecosystem bundles as `network:` configuration (`defaults`, `github`, `node`, `python`, etc.). Default is `["localhost", "127.0.0.1"]` for security. Supports wildcards like `*.example.com`.
231
140
232
141
## Custom MCP Servers (`mcp-servers:`)
233
142
234
-
Use `mcp-servers:` to integrate custom Model Context Protocol servers for third-party services, APIs, or specialized tools.
235
-
236
-
### Basic Configuration
143
+
Integrate custom Model Context Protocol servers for third-party services, APIs, or specialized tools:
- `command:`+ `args:` - Process-based MCP server (Node.js, Python, etc.)
169
+
- `container:`- Docker container image
170
+
- `url:`+ `headers:` - HTTP endpoint with authentication
171
+
- `env:`- Environment variables for the MCP server
172
+
- `allowed:`- Restrict to specific tool names
333
173
334
-
MCP servers run alongside the AI engine in isolated environments with controlled network access. See [MCPs Guide](/gh-aw/guides/mcps/) for detailed setup instructions and examples.
174
+
MCP servers run in isolated environments with controlled network access. See [MCPs Guide](/gh-aw/guides/mcps/) for detailed setup instructions.
0 commit comments