Reconcile README/CONTRIBUTING with implemented CLI, env, and config behavior - #9745
Conversation
There was a problem hiding this comment.
Pull request overview
Aligns contributor and user documentation with current CLI, configuration, environment-variable, and maintenance workflows.
Changes:
- Expands README configuration, CLI, and environment guidance.
- Documents additional Make targets and standardizes project naming.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates runtime and configuration reference material. |
| CONTRIBUTING.md | Revises testing, maintenance, release, and naming guidance. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Medium
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
🔒 mcpg Read-Only Stress — gVisorSurface coverage: MCP tool calls + proxied CLI (REST) + GraphQL mutations
B detail: All 7 MCP write tools absent from gateway allowlist — D/E detail: Overall: PASS References: §29788279585
|
🔒 mcpg Read-Only Stress — default AWFSurface coverage: MCP tool calls + proxied CLI (REST) + GraphQL mutations
Overall: PASS
References: §29788279677
|
🔒 mcpg Read-Only Stress — docker-sbxSurface coverage: MCP tool calls + proxied CLI (REST) + GraphQL mutations
Overall: PASS
|
Nightly docs reconciliation found drift between documentation and implementation across CLI flags, environment variables, gateway schema requirements, and Make target behavior. This PR tightens README/CONTRIBUTING to match current runtime/config semantics and reduce user misconfiguration risk.
README: quick-start + schema requirements
gateway.portandgateway.domain.README: CLI flags coverage
--config,--config-stdin,--listen,--routed,--unified,--validate-env,--sequential-launch, etc.)--guards-mode,--guard-policy-json,--allowonly-*,--tls-*,--hmac-secret)--otlp-*)./awmg --helpas the authoritative full reference.README: environment variable completeness
MCP_GATEWAY_PORTGITHUB_API_URL,GITHUB_SERVER_URLMCP_GATEWAY_GUARDS_MODE,MCP_GATEWAY_WASM_GUARDS_DIRMCP_GATEWAY_ALLOWONLY_SCOPE_PUBLIC/OWNER/REPO/MIN_INTEGRITYOTEL_EXPORTER_OTLP_HEADERS,GH_AW_OTLP_ENDPOINTSMCP_GATEWAY_API_KEYis lower precedence thanMCP_GATEWAY_AGENT_ID.README: config/table signposting
docs/CONFIGURATION.mdfor TOML-only server fields (working_directory,rate_limit_threshold,rate_limit_cooldown) and full field coverage.CONTRIBUTING: target behavior + naming consistency
make test-allwording to reflect incremental rebuild behavior (not unconditional rebuild).format,clean,agent-finished,help) and release invocation note.{ "gateway": { "port": 8000, "domain": "${MCP_GATEWAY_DOMAIN}", "agentId": "${MCP_GATEWAY_AGENT_ID}" } }