Commit f0c7a54
authored
Fix documentation to match implementation (#568)
Documentation contained incorrect defaults, missing flags, wrong
environment variable names, and invalid configuration examples.
## Changes
**README.md**
- Updated Usage section with missing flags: `--enable-difc`,
`--sequential-launch`, `-v/--verbose`, `--version`
- Fixed default values:
- `--config`: no default (was incorrectly documented as "config.toml")
- `startupTimeout`: 60 seconds (was documented as 30)
- `toolTimeout`: 120 seconds (was documented as 60)
- Clarified TOML vs JSON configuration differences:
- **TOML**: uses `command` and `args` fields directly
- **JSON**: uses `container` field; `command` field not supported
- Fixed environment variables used by `run.sh`:
- `HOST` (not `MCP_GATEWAY_HOST`)
- `MODE` (not `MCP_GATEWAY_MODE`)
- Added `gateway.domain` validation constraints: must be `"localhost"`
or `"host.docker.internal"`
- Fixed configuration example to use valid domain value
**CONTRIBUTING.md**
- Fixed `run.sh` defaults: `0.0.0.0:8000` (not `127.0.0.1:3000`)
- Fixed `HOST` default: `0.0.0.0` (not `127.0.0.1`)
## Example
Invalid configuration (old docs):
```json
{
"gateway": {
"domain": "example.com",
"startupTimeout": 30,
"toolTimeout": 60
}
}
```
Valid configuration (updated):
```json
{
"gateway": {
"domain": "localhost",
"startupTimeout": 60,
"toolTimeout": 120
}
}
```
All configuration examples now validate successfully against the JSON
schema.
> [!WARNING]
>
> <details>
> <summary>Firewall rules blocked me from connecting to one or more
addresses (expand for details)</summary>
>
> #### I tried to connect to the following addresses, but was blocked by
firewall rules:
>
> - `invalid-host-that-does-not-exist-12345.com`
> - Triggering command: `/tmp/go-build1927097657/b257/config.test
/tmp/go-build1927097657/b257/config.test
-test.testlogfile=/tmp/go-build1927097657/b257/testlog.txt
-test.paniconexit0 -test.timeout=10m0s -test.v=true
/tmp/go-build3894609106/b152/_pkg_.a -trimpath ocumentation-accuracy -p
crypto/internal/-unsafeptr=false -lang=go1.25 git ls-f��
--exclude-standard tation
- Fixed HOST default in CONTRIBUTING.md (0.0.0.0, not 127.0.0.1)
- Fixed startup address-atomic ash go1.25.6 -c=4 -nolocalimports bash`
(dns block)
> - `nonexistent.local`
> - Triggering command: `/tmp/go-build1927097657/b269/launcher.test
/tmp/go-build1927097657/b269/launcher.test
-test.testlogfile=/tmp/go-build1927097657/b269/testlog.txt
-test.paniconexit0 -test.timeout=10m0s -test.v=true HEAD -D cal/bin/bash
-D ation for domain-unsafeptr=false -gensymabis bash --no�� --noprofile
y x_amd64/vet
ntime.v2.task/mo/opt/hostedtoolcache/go/1.25.6/x64/pkg/tool/linux_amd64/compile
goarch/goarch.go-o 64/pkg/tool/linu/tmp/go-build1927097657/b260/_pkg_.a
x_amd64/vet` (dns block)
> - `this-host-does-not-exist-12345.com`
> - Triggering command: `/tmp/go-build1927097657/b278/mcp.test
/tmp/go-build1927097657/b278/mcp.test
-test.testlogfile=/tmp/go-build1927097657/b278/testlog.txt
-test.paniconexit0 -test.timeout=10m0s -test.v=true --noprofile` (dns
block)
>
> If you need me to access, download, or install something from one of
these locations, you can either:
>
> - Configure [Actions setup
steps](https://gh.io/copilot/actions-setup-steps) to set up my
environment, which run before the firewall is enabled
> - Add the appropriate URLs or hosts to the custom allowlist in this
repository's [Copilot coding agent
settings](https://github.com/githubnext/gh-aw-mcpg/settings/copilot/coding_agent)
(admins only)
>
> </details>
<!-- START COPILOT CODING AGENT TIPS -->
---
💬 We'd love your input! Share your thoughts on Copilot coding agent in
our [2 minute survey](https://gh.io/copilot-coding-agent-survey).2 files changed
Lines changed: 52 additions & 27 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
128 | | - | |
| 128 | + | |
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
| |||
399 | 399 | | |
400 | 400 | | |
401 | 401 | | |
402 | | - | |
| 402 | + | |
403 | 403 | | |
404 | 404 | | |
405 | 405 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
76 | 80 | | |
77 | 81 | | |
| 82 | + | |
| 83 | + | |
78 | 84 | | |
79 | 85 | | |
80 | 86 | | |
| |||
87 | 93 | | |
88 | 94 | | |
89 | 95 | | |
| 96 | + | |
| 97 | + | |
90 | 98 | | |
91 | 99 | | |
92 | 100 | | |
| |||
112 | 120 | | |
113 | 121 | | |
114 | 122 | | |
115 | | - | |
| 123 | + | |
116 | 124 | | |
117 | 125 | | |
118 | 126 | | |
| |||
126 | 134 | | |
127 | 135 | | |
128 | 136 | | |
129 | | - | |
| 137 | + | |
130 | 138 | | |
131 | | - | |
| 139 | + | |
| 140 | + | |
132 | 141 | | |
133 | 142 | | |
134 | 143 | | |
| |||
153 | 162 | | |
154 | 163 | | |
155 | 164 | | |
156 | | - | |
157 | | - | |
158 | | - | |
159 | | - | |
160 | | - | |
161 | | - | |
162 | | - | |
163 | | - | |
164 | | - | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
165 | 178 | | |
166 | 179 | | |
167 | 180 | | |
| |||
171 | 184 | | |
172 | 185 | | |
173 | 186 | | |
174 | | - | |
| 187 | + | |
| 188 | + | |
175 | 189 | | |
176 | | - | |
| 190 | + | |
177 | 191 | | |
178 | 192 | | |
179 | 193 | | |
| |||
190 | 204 | | |
191 | 205 | | |
192 | 206 | | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
193 | 212 | | |
194 | 213 | | |
195 | | - | |
196 | | - | |
197 | | - | |
198 | | - | |
199 | | - | |
200 | | - | |
201 | | - | |
202 | | - | |
203 | | - | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
204 | 229 | | |
205 | 230 | | |
206 | 231 | | |
| |||
226 | 251 | | |
227 | 252 | | |
228 | 253 | | |
229 | | - | |
230 | | - | |
| 254 | + | |
| 255 | + | |
231 | 256 | | |
232 | 257 | | |
233 | 258 | | |
| |||
0 commit comments