Conversation
Agent-Logs-Url: https://github.com/github/gh-aw-mcpg/sessions/1ee1c760-d6e5-47d7-9ad6-c3404096e622 Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates user-facing documentation to cover previously undocumented guard-policy fields and proxy flags, aligning docs with implemented configuration behavior in the gateway and proxy tooling.
Changes:
- Document
trusted-usersunder theallow-onlyguard policy, including JSON examples. - Add
--trusted-botsand--trusted-usersto the proxy mode flags table. - Clarify
run.shenvironment behavior: fallback toPORTwhenMCP_GATEWAY_PORTis unset.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/PROXY_MODE.md | Adds missing proxy CLI flags to the documented flags table. |
| docs/ENVIRONMENT_VARIABLES.md | Documents run.sh’s PORT fallback behavior alongside HOST/MODE. |
| docs/CONFIGURATION.md | Documents allow-only policy fields: blocked-users, approval-labels, and trusted-users. |
| README.md | Adds trusted-users to the guard policy quick reference and example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **`blocked-users`** *(optional)* — Array of GitHub usernames whose content is unconditionally blocked. Items from these users receive `blocked` integrity (below `none`) and are always denied, even when `min-integrity` is `"none"`. Cannot be overridden by `approval-labels`. | ||
|
|
||
| **`approval-labels`** *(optional)* — Array of GitHub label names that promote a content item's effective integrity to `approved` when present. Enables human-review gates where a maintainer labels an item to allow it through. Uses `max(base, approved)` so it never lowers integrity. Does not override `blocked-users`. | ||
|
|
||
| **`trusted-users`** *(optional)* — Array of GitHub usernames whose content is unconditionally elevated to `approved` integrity. Useful for granting specific external contributors (e.g., trusted open-source maintainers) the same treatment as repository members, without lowering `min-integrity` globally. Uses `max(base, approved)` so it never lowers integrity. Does not override `blocked-users`. |
There was a problem hiding this comment.
The blocked-users description says it cannot be overridden by approval-labels, but with trusted-users now documented it would be clearer to also state that blocked-users takes precedence over trusted-users as well (this matches guard behavior: blocked-users overrides trusted-users). Otherwise readers may assume trusted-users can re-approve a blocked login.
| | `--github-api-url` | `https://api.github.com` | Upstream GitHub API URL | | ||
| | `--tls` | `false` | Enable HTTPS with auto-generated self-signed certificates | | ||
| | `--tls-dir` | `<log-dir>/proxy-tls` | Directory for generated TLS certificate files | | ||
| | `--trusted-bots` | *(disabled)* | Additional trusted bot usernames (comma-separated, extends built-in list) | | ||
| | `--trusted-users` | *(disabled)* | User logins that receive approved integrity (comma-separated) | |
There was a problem hiding this comment.
In the flags table, the --github-api-url default is shown as https://api.github.com, but the actual behavior is: empty by default, then auto-derived from GITHUB_API_URL/GITHUB_SERVER_URL, and only then falls back to https://api.github.com (see internal/cmd/proxy.go flag help + runProxy resolution). Update the Default column to reflect this auto-derive behavior so the table matches runtime behavior.
Three fields/flags present in code were missing from user-facing docs, discovered by nightly reconciliation.
Changes
README.md + docs/CONFIGURATION.md — Document
trusted-usersin theallow-onlyguard policy section alongsideblocked-usersandapproval-labels. The field elevates specific GitHub usernames toapprovedintegrity without loweringmin-integrityglobally:docs/PROXY_MODE.md — Add
--trusted-botsand--trusted-usersto the flags table (both registered ininternal/cmd/proxy.gobut absent from the table).docs/ENVIRONMENT_VARIABLES.md — Extend the
PORT/HOST/MODEnote to mention thatrun.shfalls back to barePORTwhenMCP_GATEWAY_PORTis unset.✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.