Conversation
The tools.github.mode field now accepts three values: local (default), remote, and gh-proxy. The gh-proxy mode was introduced in #27707 as the preferred alternative to the legacy features.cli-proxy flag, but was not yet reflected in the github-tools.md reference page. Expands the "GitHub Tools Remote Mode" section into "GitHub Tools Access Modes" with a summary table and prose for each of the three modes. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the GitHub Tools reference documentation to include the newly introduced tools.github.mode: gh-proxy access mode.
Changes:
- Renames the “GitHub Tools Remote Mode” section to “GitHub Tools Access Modes”.
- Documents
tools.github.modeoptions in a table, addinggh-proxymode and describing its behavior and usage. - Adds a dedicated configuration example and explanation for
gh-proxymode.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/reference/github-tools.md |
Documents GitHub Tools access modes, including the new gh-proxy mode and example configuration. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
| @@ -94,17 +94,33 @@ The `repos` field was renamed to `allowed-repos` to better reflect its purpose. | |||
|
|
|||
| By default, the GitHub Tools can read from the current repository and all public repositories (if permitted by the network firewall). To read from other private repositories, you must configure additional authentication. See [Cross-Repository Operations](/gh-aw/reference/cross-repository/) for details and examples. | |||
|
|
|||
There was a problem hiding this comment.
This section heading was renamed to “GitHub Tools Access Modes”, but later in this page there’s still a link to #github-tools-remote-mode (under “Additional Authentication…”). That anchor will no longer exist; update the link/label to point at the new #github-tools-access-modes section (or restore a matching heading ID).
| <a id="github-tools-remote-mode"></a> |
| The `tools.github.mode` field controls how the agent accesses GitHub. Three values are supported: | ||
|
|
||
| | Mode | Transport | Notes | | ||
| |------|-----------|-------| | ||
| | `local` (default) | Docker-based GitHub MCP Server inside the Actions VM | No extra authentication required | |
There was a problem hiding this comment.
The text says only three tools.github.mode values are supported, but the code also accepts the legacy alias cli for gh-proxy (see pkg/workflow/mcp_github_config.go, which maps cli -> gh-proxy). Please document cli as a deprecated alias (e.g., in the table or in the gh-proxy section) so existing workflows are covered.
Self-Healing Documentation Fixes
This PR was automatically created by the Daily Documentation Healer workflow.
Gaps Fixed
Commit Refactor cli-proxy feature into tools.github.mode (gh-proxy) with codemod migration #27707 (
Refactor cli-proxy feature into tools.github.mode (gh-proxy) with codemod migration, merged 2026-04-22T01:11Z) introducedtools.github.mode: gh-proxyas the preferred alternative to the legacyfeatures.cli-proxyflag, but thereference/github-tools.mdreference page was not updated.The "GitHub Tools Remote Mode" section only documented
localandremotemodes.gh-proxymode (and its aliascli) were absent. Users who follow the reference to configure GitHub Tools access would have no way of discovering this new preferred mode.Root Cause
DDUw did not produce a docs PR for today's (2026-04-22) changes. Commit #27707 landed at 01:11 UTC — before the DDUw's 10:00 UTC run window — but the DDUw run appears to have been blocked by protected-file changes (see #27826 which merged the fix for this at 13:26 UTC). As a result, the
gh-proxymode change was not captured in any[docs]PR.💡 DDUw Improvement Suggestions
DDUw Improvement Suggestions
tools.github.modevalues against thegithub-tools.mdreference page when it detects changes topkg/workflow/mcp_github_config.go. Adding a scan step for mode/option enum additions inmcp_github_config.gowould catch this class of gap.Related Issues
References:
Smoke CI scheduled run observed this PR. Run URL: https://github.com/github/gh-aw/actions/runs/24781286728