Commit 22a6707
authored
docs: reconcile env-variable semantics and server config docs with implementation (#5475)
## Bug Fix
### What was the bug?
Nightly reconciliation found multiple doc/implementation mismatches:
`MCP_GATEWAY_PORT/DOMAIN/API_KEY` were documented as automatic config
overrides (they are not), `tool_response_filters` was undocumented, and
contributor/example docs were missing or inaccurate in a few high-impact
spots.
### How did you fix it?
- **Environment variable behavior clarified (`AGENTS.md`)**
- Updated `MCP_GATEWAY_PORT`, `MCP_GATEWAY_DOMAIN`, and
`MCP_GATEWAY_API_KEY` descriptions to match actual runtime behavior
(validation/container checks vs. automatic gateway field override).
- Clarified `MCP_GATEWAY_PORT` vs plain `PORT` semantics in the note at
the end of the environment variable section.
- **Missing server field documentation added (`docs/CONFIGURATION.md`)**
- Added `tool_response_filters` under server configuration fields.
- Documented expected shape (`map[toolName]jqExpression`) and startup
validation behavior for jq expressions.
- **Configuration example coverage expanded (`config.example.toml`)**
- Added commented examples for:
- `tool_response_filters`
- `connect_timeout`
- per-server `tool_timeout`
- `rate_limit_threshold`
- `rate_limit_cooldown`
- HTTP `auth` (`github-oidc`)
- `working_directory`
- `registry`
- **Contributor docs corrected (`CONTRIBUTING.md`)**
- Added missing direct dependency `github.com/spf13/pflag`.
- Corrected project tree root label from `awmg/` to `gh-aw-mcpg/`.
### Testing
Docs-only change; no production logic changes.
```toml
# Example now documented in config.example.toml
[servers.github.tool_response_filters]
search_code = ".results[:20]"
get_file_contents = "{path: .path, sha: .sha}"
```4 files changed
Lines changed: 39 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
376 | 376 | | |
377 | 377 | | |
378 | 378 | | |
379 | | - | |
380 | | - | |
381 | | - | |
| 379 | + | |
| 380 | + | |
| 381 | + | |
382 | 382 | | |
383 | 383 | | |
384 | 384 | | |
| |||
403 | 403 | | |
404 | 404 | | |
405 | 405 | | |
406 | | - | |
| 406 | + | |
407 | 407 | | |
408 | 408 | | |
409 | 409 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
247 | 247 | | |
248 | 248 | | |
249 | 249 | | |
250 | | - | |
| 250 | + | |
251 | 251 | | |
252 | 252 | | |
253 | 253 | | |
| |||
425 | 425 | | |
426 | 426 | | |
427 | 427 | | |
| 428 | + | |
428 | 429 | | |
429 | 430 | | |
430 | 431 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
78 | 85 | | |
79 | 86 | | |
80 | 87 | | |
| |||
143 | 150 | | |
144 | 151 | | |
145 | 152 | | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
146 | 158 | | |
147 | 159 | | |
148 | 160 | | |
| |||
157 | 169 | | |
158 | 170 | | |
159 | 171 | | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
160 | 177 | | |
161 | 178 | | |
162 | 179 | | |
163 | 180 | | |
164 | 181 | | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
165 | 187 | | |
166 | 188 | | |
167 | 189 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
166 | 166 | | |
167 | 167 | | |
168 | 168 | | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
169 | 180 | | |
170 | 181 | | |
171 | 182 | | |
| |||
0 commit comments