You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit adc707c
Browse filesBrowse the repository at this point in the historyBrowse files
fix(docs): curate LLM exports and correct authentication guidance (#1734)
## Problem and change
The documentation LLM index advertised 71 unpublished pages that
returned 404, while the full export included internal research, plans
and historical investigations. Share the HTML publication
allowlist/exclusions with the LLM plugin so both exports contain only
published docs. The resulting index contains 129 links, all matched to
Docusaurus metadata and generated HTML.
Correct the MCP authentication reference to distinguish optional local
HTTP auth, compatibility admin access for anonymous callers, enforced
auth, Server edition and OS-authenticated local transports. Replace the
homepage's overclaiming diagram with an accessible SVG stating the
limits of protection. Add descriptions to seven category pages, exclude
noindexed search from the sitemap, and publish robots.txt with the
sitemap location.
## Validation
- `npm ci --no-audit --no-fund`
- `npm run build` — production build and automatic postbuild validation
passed.
- New verifier reproduced the original defect: `LLM export links to
unpublished page: https://docs.mcpproxy.app/docs/E2E_TESTING`.
- Fixed output: `Verified 129 published LLM links, full-export
regression markers, category metadata, sitemap and robots.txt.`
- Mutation checks rejected an injected unpublished URL and internal
workflow marker; generated files restored and verifier passed again.
- Browser inspection confirmed the SVG and authentication table render
correctly.
- Independent fresh-context review: `VERDICT: PASS` after correcting the
anonymous-admin compatibility wording. No remaining actionable findings.
The postbuild gate runs through the existing PR, main deployment and
release `npm run build` paths. Runtime behavior is unchanged. Broader
navigation and per-page Markdown work remain outside this PR.
## Deployed preview
[Cloudflare preview](https://68e931e9.mcpproxy-docs.pages.dev/) verified
live: all 129 exported routes load; the full export excludes the known
internal-note regression markers; the auth matrix, replacement SVG,
sitemap and robots declaration are present. Full export is approximately
1.43 MB, down from 3.04 MB in the audited production snapshot.
The publication arrays remain literal in `docusaurus.config.js` for the
existing release-gate parser, while both builders reference that same
object. Reproduced the three parser failures from the first CI run,
fixed compatibility, and passed `go test ./cmd/release-gate -count=1`, a
fresh production docs build, and independent follow-up review (`VERDICT:
PASS`).
Copy file name to clipboardExpand all lines: docs/api/mcp-protocol.md
+17-1Lines changed: 17 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,23 @@ Each routing mode has a dedicated endpoint that is always available regardless o
34
34
35
35
See [Routing Modes](../features/routing-modes.md) for details on each mode.
36
36
37
-
**Note:** MCP endpoints do not require API key authentication for client compatibility.
37
+
### Authentication
38
+
39
+
Authentication depends on the deployment and transport:
40
+
41
+
| Surface | Authentication |
42
+
| --- | --- |
43
+
| Local MCP over HTTP, default configuration | Authentication is optional (`require_mcp_auth: false`). Anonymous callers retain admin-level tool and management access for compatibility, subject to enabled tools and configuration gates; they cannot use the opt-in raw secret-header reveal. |
44
+
| MCP over HTTP with `require_mcp_auth: true`| Requires a valid credential, such as an admin API key or a scoped agent token. Enable this before exposing MCP beyond localhost. |
45
+
| Server edition with `server_edition.enabled: true`| Forces MCP authentication on, even if `require_mcp_auth` is explicitly false. |
46
+
| REST API over HTTP | Requires authentication independently of `require_mcp_auth`. |
47
+
| Local Unix socket / Windows named pipe | Uses OS-level access control; trusted local connections do not need an API key. |
48
+
49
+
See [configuration defaults](/configuration/config-file#server-settings),
50
+
[agent tokens and MCP authentication](/features/agent-tokens#enforcing-authentication-on-mcp),
51
+
[REST authentication](/api/rest-api#authentication), and

0 commit comments