📚 Documentation Reconciliation Report - 2026-07-21

[github-actions]

Summary

Nightly documentation reconciliation completed. Documentation is largely accurate and in sync with the implementation. One minor discrepancy was identified.

• Workflow Run: §29875638596
• Date: 2026-07-21
• Branch: main

Minor Issues 🔵

1. CONTRIBUTING.md lists Docker images that are not used in tests or code

Location: CONTRIBUTING.md, lines 44–49 ("Initial Setup → Pull required Docker images")

Problem: The setup instructions list three Docker images to pull:

docker pull ghcr.io/github/github-mcp-server:latest
docker pull mcp/fetch
docker pull mcp/memory

Only ghcr.io/github/github-mcp-server:latest is referenced in the codebase. mcp/fetch and mcp/memory do not appear in any Go source files, test files, or Makefile targets. Pulling them is unnecessary for building or running tests.

Impact: Contributor setup takes longer than necessary and may fail in restricted environments where these images are unavailable.

Suggested Fix: Remove or mark mcp/fetch and mcp/memory as optional example images, not required prerequisites.

Code Reference: CONTRIBUTING.md:44-49 — no matches in internal/**/*.go or test/**/*.go

Accurate Sections ✅

The following areas were verified accurate:

• README.md: Docker quick start JSON config structure matches config_stdin.go struct definitions
• README.md: gateway.port and gateway.domain are correctly identified as schema-required (confirmed in mcp-gateway-config.schema.json → definitions.gatewayConfig.required)
• README.md: Environment variable names and token priority order match code
• README.md: JSON stdin field names (agentId, payloadDir, trustedBots, forcePublicRepos, connectTimeout, toolTimeout, etc.) all exist in config_stdin.go
• README.md: TOML stdio command = "docker" containerization requirement matches validation code
• README.md: -i docker flag description is accurate (enables stdin for piping JSON config)
• README.md: Port table entry clarification (line 220) correctly notes MCP_GATEWAY_PORT is for --validate-env only
• CONTRIBUTING.md: Go version requirement (1.25.0) matches go.mod
• CONTRIBUTING.md: All make targets listed (build, test, test-unit, test-integration, test-all, lint, coverage, install, agent-finished, format, clean) exist in Makefile
• CONTRIBUTING.md: Binary name (awmg) matches Makefile output
• CONTRIBUTING.md: agent-finished description (format + build + lint + tests) matches Makefile implementation
• docs/CONFIGURATION.md: Mount ${VAR} syntax correctly documented — JSON variable expansion occurs before mount validation
• docs/ENVIRONMENT_VARIABLES.md: All env vars found in code (GITHUB_REPOSITORY, MCP_GATEWAY_API_KEY, GH_AW_OTLP_ENDPOINTS, etc.) are documented

Tested Commands

• ✅ make --dry-run build — target exists and matches documented description
• ✅ make --dry-run test — delegates to test-unit, matches docs
• ✅ make --dry-run test-unit — exists, runs go test ./...
• ✅ make --dry-run test-integration — exists, auto-builds binary
• ✅ make --dry-run test-all — exists, builds binary then runs all tests
• ✅ make --dry-run lint — exists, runs go vet, gofmt, golangci-lint
• ✅ make --dry-run coverage — exists
• ✅ make --dry-run install — exists
• ✅ make --dry-run agent-finished — exists, pipeline matches documented pipeline
• ⚠️ make build / ./awmg --help — binary build blocked by Go toolchain download restrictions in CI sandbox (go1.25.0 download returned HTTP 403); CLI flag verification was skipped

Code References

• Configuration structs: internal/config/config_core.go, internal/config/config_stdin.go
• Schema: internal/config/schema/mcp-gateway-config.schema.json
• Validation logic: internal/config/validation_rules.go, internal/config/validation_gateway.go
• Variable expansion: internal/config/config_stdin.go:349-365

Warning

Firewall blocked 2 domains

The following domains were blocked by the firewall during workflow execution:

• awmgmcpg
• proxy.golang.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "awmgmcpg"
    - "proxy.golang.org"

See Network Configuration for more information.

Generated by Nightly Documentation Reconciler · 88 AIC · ⊞ 4.7K · ◷

• expires on Jul 24, 2026, 11:05 PM UTC