Skip to content

Commit acac0a6

Browse files
docs: document GHES audit auto-detection and write-sink guard policy expansion
- cli.md: note that gh aw audit and add-wizard auto-detect the GHES host from the git remote (from #20973), so GH_HOST is not required manually - github-tools.md: update Safe Outputs Integration section to reflect that write-sink guard policies are now derived for ALL non-GitHub MCP servers (playwright, serena, mcp-scripts, agentic-workflows, web-fetch, custom tools), not only safe-outputs (from #21005) Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
1 parent 08a903b commit acac0a6

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

docs/src/content/docs/reference/github-tools.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,17 +144,19 @@ tools:
144144
min-integrity: approved
145145
```
146146

147-
### Safe Outputs Integration
147+
### Non-GitHub MCP Server Integration
148148

149-
When you configure `repos` in the GitHub guard policy, the compiler automatically derives a linked guard-policy for the [safe outputs](/gh-aw/reference/safe-outputs/) MCP server:
149+
When you configure `repos` in the GitHub guard policy, the compiler automatically derives a linked write-sink guard-policy for **all non-GitHub MCP servers** — including [safe outputs](/gh-aw/reference/safe-outputs/), playwright, serena, mcp-scripts, agentic-workflows, web-fetch, and any custom tools. This ensures that as guard policies are applied to GitHub inputs, the corresponding write operations to non-GitHub servers are permitted.
150150

151-
- **`repos: "all"` or `repos: "public"`**: Creates a write-sink policy with `accept: ["*"]` to allow all safe output operations
152-
- **`repos: [patterns]`**: Each entry in the `repos` list is transformed and added as an accept entry in the safeoutputs policy:
151+
The transformation rules are:
152+
153+
- **`repos: "all"` or `repos: "public"`**: Creates a write-sink policy with `accept: ["*"]` to allow all write operations
154+
- **`repos: [patterns]`**: Each entry is transformed and added as an accept entry:
153155
- `"owner/*"` → `"private:owner"` (owner wildcard → strip wildcard)
154156
- `"owner/prefix*"` → `"private:owner/prefix*"` (prefix wildcard → keep as-is)
155157
- `"owner/repo"` → `"private:owner/repo"` (specific repo → keep as-is)
156158

157-
This derivation happens at compile time and requires no additional configuration, allowing the MCP gateway to read repository data through the GitHub tools and still write outputs via safeoutputs.
159+
This derivation happens at compile time and requires no additional configuration, allowing the MCP gateway to read repository data through the GitHub tools and write outputs to any configured non-GitHub MCP server.
158160

159161
```yaml wrap
160162
tools:

docs/src/content/docs/setup/cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ gh aw logs workflow --repo github.enterprise.com/owner/repo # Use with comm
7777

7878
Commands that support `--create-pull-request` (such as `gh aw add`, `gh aw add-wizard`, `gh aw init`, `gh aw update`, and `gh aw upgrade`) automatically detect the enterprise host from the git remote and route PR creation to the correct GHES instance. No extra flags are needed.
7979

80+
`gh aw audit` and `gh aw add-wizard` also auto-detect the GHES host from the git remote, so running them inside a GHES repository works without setting `GH_HOST` manually.
81+
8082
#### Configuring `gh` CLI in workflow steps on GHES
8183

8284
When agentic workflows run on GitHub Enterprise Server and use custom `steps:` that invoke `gh` CLI commands, source the bundled helper script to configure `gh` for the enterprise host:

0 commit comments

Comments
 (0)