docs: fix documentation discrepancies from reconciliation report 2026-03-13#1919
Merged
docs: fix documentation discrepancies from reconciliation report 2026-03-13#1919
Conversation
…-03-13 - AGENTS.md: add Test-CI make target to Quick Start - AGENTS.md: remove stale '21 comprehensive' test count - AGENTS.md: add 8 missing env vars (DIFC/guard/container) - README.md: add working_directory, registry, guard, headers, tools server fields - README.md: add guards_mode TOML top-level config key documentation - README.md: fix sequential_launch section incorrectly referencing [gateway] Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
lpcox
March 14, 2026 23:35
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-only PR to resolve discrepancies flagged by the nightly documentation reconciliation report, aligning README/agent docs with current MCP Gateway configuration and CI/testing workflows.
Changes:
- Document additional server config fields in
README.md(headers,tools,registry,guard,working_directory) and clarify TOML placement forsequential_launchandguards_mode. - Update
AGENTS.mdQuick Start withmake test-ciand refresh/expand documented environment variables used by the gateway.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Adds/adjusts configuration field documentation and TOML key placement examples. |
| AGENTS.md | Adds test-ci make target to Quick Start; documents additional env vars used in production. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Comment on lines
+204
to
+205
| - **`tools`** (optional): List of tool names to expose from this server | ||
| - If omitted or empty, all tools are exposed |
Comment on lines
+211
to
+214
| - **`guard`** (optional): Name of the guard to use for this server (DIFC) | ||
| - References a guard defined in the top-level `[guards]` section | ||
| - Enables per-server DIFC guard assignment independent of `guard-policies` | ||
| - Example: `guard = "github"` (uses the guard named `github` from `[guards.github]`) |
Comment on lines
+216
to
+217
| - **`working_directory`** (optional): Working directory for the server process | ||
| - **Note**: This field is parsed and stored but not yet implemented in the launcher; it has no runtime effect currently |
This was referenced Mar 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses all 6 discrepancies identified in the nightly documentation reconciliation report (#2026-03-13).
Changes
AGENTS.md
Test-CImake target to Quick Start section (make test-ci— unit tests with coverage and JSON output for CI)MCP_GATEWAY_GUARDS_MODEMCP_GATEWAY_WASM_GUARDS_DIRMCP_GATEWAY_GUARD_POLICY_JSONMCP_GATEWAY_ALLOWONLY_SCOPE_PUBLICMCP_GATEWAY_ALLOWONLY_SCOPE_OWNERMCP_GATEWAY_ALLOWONLY_SCOPE_REPOMCP_GATEWAY_ALLOWONLY_MIN_INTEGRITYRUNNING_IN_CONTAINERREADME.md — Server Configuration Fields
headersfield (HTTP headers fortype: "http"servers)toolsfield (optional tool filtering list)registryfield (informational URI to MCP registry)guardfield (per-server DIFC guard assignment, references[guards]section)working_directoryfield (parsed but not yet implemented in launcher — noted as such)README.md — TOML Configuration
guards_modedocumentation as a TOML top-level config key with example snippetsequential_launchsection: was incorrectly stating the key goes in[gateway]section; corrected to top-level with example snippetCloses #(issue number)