Skip to content

Commit 16c2c47

Browse files
authored
Reconcile AGENTS/CONTRIBUTING docs with current config and auth behavior (#6018)
Nightly docs reconciliation flagged drift between `AGENTS.md`/`CONTRIBUTING.md` and the implemented behavior. The main gaps were token fallback priority clarity and missing quick-reference mentions for supported config fields and `make help`. - **Auth token priority alignment (`AGENTS.md`)** - Clarified `GITHUB_PERSONAL_ACCESS_TOKEN` as the **third-priority** fallback. - Added missing `GH_TOKEN` as the **lowest-priority** fallback (GitHub CLI-provided token path). - **JSON stdin/TOML quick-reference completeness (`AGENTS.md`)** - Added explicit mention of optional JSON stdin fields: - stdio: `entrypoint`, `entrypointArgs`, `mounts` - http: `connectTimeout` - Added direct pointer to full references for broader field coverage: - `docs/CONFIGURATION.md` - `config.example.toml` - includes gateway/top-level fields like `keepalive_interval`, `sequential_launch`, `guards_mode`. - **Make target discoverability (`CONTRIBUTING.md`)** - Added `make help` to the documented command set so contributors can enumerate available targets directly. ```markdown - `GITHUB_PERSONAL_ACCESS_TOKEN` - Third-priority GitHub auth fallback - `GH_TOKEN` - Lowest-priority GitHub auth fallback (set by GitHub CLI) ... - **Note**: In JSON stdin format, stdio servers also support optional `entrypoint`, `entrypointArgs`, and `mounts` fields; HTTP servers support optional `connectTimeout` ```
2 parents dad2a0a + d1804c5 commit 16c2c47

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ args = ["run", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "-i", "ghcr.io/gith
9999
- **Containerization Requirement**: TOML stdio servers must use `command = "docker"` per [MCP Gateway Specification Section 3.2.1](https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/mcp-gateway.md#321-containerization-requirement)
100100
- **Note**: In JSON stdin format, the `command` field is not supported - stdio servers must use `container` field
101101
- **Note**: In JSON stdin format, `args` is optional and provides extra Docker runtime arguments inserted before the container image name
102+
- **Note**: In JSON stdin format, stdio servers also support optional `entrypoint`, `entrypointArgs`, and `mounts` fields; HTTP servers support optional `connectTimeout`
103+
- **Note**: For the full JSON stdin field list and complete TOML examples (including `gateway.keepalive_interval`, top-level `sequential_launch`, and `guards_mode`), see `docs/CONFIGURATION.md` and `config.example.toml`
102104
- Port range validation: 1-65535
103105
- Timeout validation: positive integers only
104106

@@ -378,7 +380,8 @@ DEBUG_COLORS=0 DEBUG=* ./awmg --config config.toml
378380

379381
- `GITHUB_MCP_SERVER_TOKEN` - Highest-priority GitHub auth token (takes precedence over `GITHUB_TOKEN`, `GITHUB_PERSONAL_ACCESS_TOKEN`, `GH_TOKEN`)
380382
- `GITHUB_TOKEN` - Second-priority GitHub auth token fallback after `GITHUB_MCP_SERVER_TOKEN`
381-
- `GITHUB_PERSONAL_ACCESS_TOKEN` - GitHub auth
383+
- `GITHUB_PERSONAL_ACCESS_TOKEN` - Third-priority GitHub auth fallback
384+
- `GH_TOKEN` - Lowest-priority GitHub auth fallback (set by GitHub CLI)
382385
- `GITHUB_API_URL` - Explicit GitHub API endpoint (e.g., `https://copilot-api.mycompany.ghe.com`); used by proxy to set upstream target
383386
- `GITHUB_SERVER_URL` - GitHub server URL; proxy auto-derives API endpoint: `*.ghe.com``copilot-api.*.ghe.com`, GHES → `<host>/api/v3`, `github.com``api.github.com`
384387
- `ACTIONS_ID_TOKEN_REQUEST_URL` - GitHub Actions OIDC token endpoint URL; required for `github-oidc` auth type

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,11 @@ make build
5959

6060
This creates the `awmg` binary in the project root.
6161

62+
List all available Make targets:
63+
```bash
64+
make help
65+
```
66+
6267
### Testing
6368

6469
The test suite is split into two types:

0 commit comments

Comments
 (0)