📚 Documentation Reconciliation Report - 2026-05-26

[github-actions]

Summary

Found 1 discrepancy between documentation and implementation during nightly reconciliation check.

• Workflow Run: §26480120757
• Date: 2026-05-26
• Branch: main

Important Issues 🟡

1. Incorrect default path for MCP_GATEWAY_WASM_CACHE_DIR in docs/ENVIRONMENT_VARIABLES.md

Location: docs/ENVIRONMENT_VARIABLES.md — MCP_GATEWAY_WASM_CACHE_DIR row
Problem: The description says "defaults to <log-dir>/wazero-cache" and the Default column shows /tmp/gh-aw/mcp-logs/wazero-cache, implying the wazero cache is a child of the log directory.
Actual Behavior: The code computes the default as filepath.Join(filepath.Dir(logDir), "wazero-cache") — meaning it is a sibling of the log directory, one level up. With the default log dir /tmp/gh-aw/mcp-logs, the wazero cache defaults to /tmp/gh-aw/wazero-cache.
Impact: Users configuring volume mounts or filesystem access expecting the cache at /tmp/gh-aw/mcp-logs/wazero-cache will not find it there. Operators watching disk usage in the log directory won't see the cache. Monitoring, cleanup scripts, and Docker volume configurations derived from this documentation will target the wrong path.
Suggested Fix: Update the description to "defaults to <parent-of-log-dir>/wazero-cache" and change the Default column from /tmp/gh-aw/mcp-logs/wazero-cache to /tmp/gh-aw/wazero-cache.
Code Reference: internal/cmd/wasm_cache.go:17 — return filepath.Join(filepath.Dir(logDir), config.DefaultWasmCacheDirName)

Exact fix for docs/ENVIRONMENT_VARIABLES.md:

| `MCP_GATEWAY_WASM_CACHE_DIR` | Disk-backed wazero compilation cache directory (sets default for `--wasm-cache-dir`; defaults to `<parent-of-log-dir>/wazero-cache`, a sibling of the log directory) | `/tmp/gh-aw/wazero-cache` |

Note: README.md already uses the correct phrasing: "the wazero cache (<parent-of-log-dir>/wazero-cache, a sibling of --log-dir by default)". Only docs/ENVIRONMENT_VARIABLES.md needs updating.

Documentation Completeness

Accurate Sections ✅

• README.md Quick Start — Docker run command, config.json structure, --config-stdin requirement, and flag descriptions are all accurate.
• README.md Architecture section — wazero cache location phrasing is correct (<parent-of-log-dir>/wazero-cache).
• CONTRIBUTING.md Make targets — All documented targets (build, test, test-unit, test-integration, test-all, test-race, test-ci, lint, coverage, format, clean, install) exist in the Makefile and descriptions match.
• CONTRIBUTING.md Prerequisites — Go version 1.25.0 matches go.mod; Docker requirement is accurate.
• CONTRIBUTING.md CLI flags — --config-stdin, --routed, --unified, --listen, --log-dir, --env, --sequential-launch, --payload-dir all verified in internal/cmd/.
• docs/CONFIGURATION.md Server Fields — container, entrypoint, entrypointArgs, args, mounts, env, url, connectTimeout, toolTimeout, guard-policies all verified against internal/config/config_stdin.go.
• JSON stdin command field — Correctly documented as NOT supported; StdinServerConfig struct has no Command field (confirmed in internal/config/config_stdin.go:83).
• Binary name — awmg matches BINARY_NAME in Makefile.

Tested Commands

• ✅ make build — target exists and correct binary name awmg
• ✅ make test / make test-unit — alias relationship confirmed in Makefile
• ✅ make test-integration — auto-builds if binary absent (confirmed in Makefile)
• ✅ make test-all — rebuilds before running all tests
• ✅ make test-race — target exists with correct description
• ✅ make lint — runs go vet, gofmt check, and golangci-lint
• ✅ make coverage — target exists
• ✅ make install — installs golangci-lint v2.8.0 and Go deps
• ⚠️ make build — could not execute due to network firewall blocking Go 1.25.0 toolchain download from proxy.golang.org; target is correctly defined.

Recommendations

Immediate Actions Required:

1. Fix the wazero cache path in docs/ENVIRONMENT_VARIABLES.md (see exact fix above — one-line change).

Code References

• Wazero cache default logic: internal/cmd/wasm_cache.go:15-19
• Default log dir constant: internal/config/config_core.go:49 — /tmp/gh-aw/mcp-logs
• Default wazero cache dir name constant: internal/config/config_core.go:51 — wazero-cache
• Stdin config (no command field): internal/config/config_stdin.go:83-85

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

• proxy.golang.org

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

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

See Network Configuration for more information.

Generated by Nightly Documentation Reconciler · sonnet46 1.8M · ◷

• expires on May 29, 2026, 11:06 PM UTC