Commit a2aac30
authored
Reconcile docs with MCP_GATEWAY_PORT runtime behavior and Rust guard test guidance (#6039)
Nightly docs reconciliation found mismatches between documented env/test
behavior and implementation, centered on `MCP_GATEWAY_PORT`
semantics/defaults and incomplete contributor guidance. This PR aligns
docs and one config comment with current runtime behavior.
- **Environment variable semantics (`docs/ENVIRONMENT_VARIABLES.md`)**
- Corrects `MCP_GATEWAY_PORT` wording: it is used by `run.sh` /
`run_containerized.sh` to construct `--listen`, and by `awmg` only for
`--validate-env` checks.
- Removes conflicting value by aligning the production-table value with
the script default (`8000`).
- Expands the note to clearly separate script-read vars
(`HOST`/`PORT`/`MODE`) from binary behavior.
- **Contributor workflow clarity (`CONTRIBUTING.md`)**
- Adds a dedicated **Rust Guard Tests** section for `make test-rust` and
its `cargo` requirement.
- Tightens `make agent-finished` wording to reflect what it actually
runs (`go test ./...` + Rust guard tests).
- **Agent quick reference alignment (`AGENTS.md`)**
- Updates `Agent-Finished` description to explicitly include unit,
integration, and Rust guard tests.
- **JSON stdin config intent (`internal/config/config_stdin.go`)**
- Adds a `StdinServerConfig` comment clarifying intentional omission of
`command` in JSON stdin format (stdio uses `container`).
```md
`MCP_GATEWAY_PORT` is read by the binary for `--validate-env` port-mapping checks only; it does **not** auto-configure the listen address.
```4 files changed
Lines changed: 14 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
100 | 107 | | |
101 | 108 | | |
102 | 109 | | |
| |||
589 | 596 | | |
590 | 597 | | |
591 | 598 | | |
592 | | - | |
| 599 | + | |
593 | 600 | | |
594 | 601 | | |
595 | 602 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
39 | 39 | | |
40 | 40 | | |
41 | 41 | | |
42 | | - | |
| 42 | + | |
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
| 83 | + | |
| 84 | + | |
83 | 85 | | |
84 | 86 | | |
85 | 87 | | |
| |||
0 commit comments