docs: document the public docs MCP server - #718
Open
nnayz wants to merge 3 commits into
Open
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 92fbfa9560
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Mintlify's contextual mcp option already serves a working, read-only MCP server over the docs site (search + page retrieval + canonical links), so this documents it and distinguishes it from the workspace MCP server instead of building a new one. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. 👍 Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
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
1 participant
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.
Closes #711
Closes the "docs MCP server" ask: rather than standing up a new server, this validates and documents the one Mintlify already generates from
docs.json'scontextual.options: ["mcp"].Verified live against
https://docs.mirage.strukto.ai/mcp:search_mirage— natural-language search, returns titles, canonical URLs, and excerpts.query_docs_filesystem_mirage— read-only shell (cat/head/rg/tree) over the docs'.mdx/OpenAPI content, i.e. page retrieval as Markdown.submit_feedback— reports a bad/outdated page to the docs team.A
mintlify://skills/struktoaiMCP resource exposing an auto-generated Claude-Skill-style quick reference.No auth, no session handshake (stateless), no access to a user's workspace or credentials.
docs/home/docs-mcp.mdx— new page (wired into the Home nav's Learn group) with setup snippets for Claude Code, Codex, Cursor, and VS Code, a tools table, and a section explicitly distinguishing this from the workspace MCP server (MirageServer/createMirageMcpServer) that agent-SDK integrations already expose.scripts/check_docs_mcp.py— stdlib-only smoke test: calls the live endpoint, asserts a known page (/home/install.mdx) retrieves correctly and that search surfaces its canonical URL..github/workflows/test_docs_mcp.yml— runs that check on PRs touchingdocs/docs.json/the script, daily on a schedule, and on manual dispatch, so a broken deployment fails CI instead of silently degrading every connected agent.Test plan
./python/.venv/bin/pre-commit run --files docs/docs.json docs/home/docs-mcp.mdx scripts/check_docs_mcp.py .github/workflows/test_docs_mcp.ymlpython3 scripts/check_docs_mcp.pyagainst the live endpoint — passesdocs/docs.jsonand the script)🤖 Generated with Claude Code