docs(MCP): Rewrite MCP server page and generate the tool catalogue#7668
Open
khvn26 wants to merge 1 commit into
Open
docs(MCP): Rewrite MCP server page and generate the tool catalogue#7668khvn26 wants to merge 1 commit into
khvn26 wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
github-actions
Bot
added
api
Member
Author
|
Vercel preview of the rewritten page: https://docs-qxrxqbi67-flagsmith.vercel.app/integrating-with-flagsmith/mcp-server |
Contributor
Docker builds report
|
github-actions
Bot
added
docs
Rewrite the user-facing MCP server page for the self-built server, replacing the Gram-hosted page: - Cloud (`https://mcp.flagsmith.com`) and self-hosted (`https://<host>/mcp/`) URLs - OAuth (auto-discovered) and `Authorization: Api-Key` authentication - Per-client install tabs: Claude Code, Cursor, Claude Desktop, Codex CLI, Windsurf, Gemini CLI, VS Code, and a generic fallback - Gram deprecation / migration callout, example prompts Generate the tool catalogue from the OpenAPI schema rather than hand-maintaining it, so descriptions stay in sync with the tools: - `manage.py generate_mcp_tool_catalogue` renders an aligned Markdown table of the MCP-tagged operations (verbatim `operationId` + `description`); `--exclude` omits tools already listed in another catalogue. - `make generate-docs` writes the core catalogue (`_mcp-tool-catalogue.md`); `api-tests-with-private-packages` derives the enterprise-only catalogue (`_mcp-tool-catalogue-enterprise.md`) against it. The page composes both via MDX imports (hence the `.md` -> `.mdx` rename). Contributes to Flagsmith/flagsmith-private#144. beep boop
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7668 +/- ##
=======================================
Coverage 98.52% 98.53%
=======================================
Files 1444 1446 +2
Lines 55083 55142 +59
=======================================
+ Hits 54273 54332 +59
Misses 810 810 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Playwright Test Results (oss - depot-ubuntu-latest-arm-16)
Details
Playwright Test Results (oss - depot-ubuntu-latest-16)
Details
Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)
Details
Playwright Test Results (private-cloud - depot-ubuntu-latest-16)
Details
Playwright Test Results (oss - depot-ubuntu-latest-arm-16)
Details
Playwright Test Results (oss - depot-ubuntu-latest-16)
Details
Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)
Details
Playwright Test Results (private-cloud - depot-ubuntu-latest-16)
Details
|
Contributor
Visual Regression19 screenshots compared. See report for details. |
khvn26
force-pushed
the
docs/rewrite-mcp-server
branch
from
5fb9cdd to
6295a4b
Compare
github-actions
Bot
added
docs
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
2 participants
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.
Thanks for submitting a PR! Please check the boxes below:
docs/if required so people know about the feature.Changes
Contributes to Flagsmith/flagsmith-private#144.
Preview: https://docs-git-docs-rewrite-mcp-server-flagsmith.vercel.app/integrating-with-flagsmith/mcp-server
Rewrites the user-facing MCP server page for the self-built server, replacing the Gram-hosted page:
https://mcp.flagsmith.com) and self-hosted (https://<your-flagsmith-host>/mcp/) URLs.Authorization: Api-Keyauthentication.Generates the tool catalogue from the OpenAPI schema instead of hand-maintaining it, so the descriptions stay in sync with the tools:
manage.py generate_mcp_tool_cataloguerenders an aligned Markdown table of the MCP-tagged operations (verbatimoperationId+description).--excludeomits tools already present in another catalogue.make generate-docswrites the core catalogue (_mcp-tool-catalogue.md, gated by the existing diff-check).api-tests-with-private-packagesderives the enterprise-only catalogue (_mcp-tool-catalogue-enterprise.md) from it (the enterprise tools only exist with private packages installed). The page composes both via MDX imports — hence the.md→.mdxrename.Note: the page documents URLs/clients ahead of the server going live (doc-led). The install snippets and the Gram deprecation date (currently 30 June 2026) should be confirmed against the live server before/at release.
How did you test this code?
make -C api generate-docsreproduces_mcp-tool-catalogue.md(36 core tools) byte-identically;make -C api typecheckand ruff pass; docs Prettier passes on the rewritten page and both partials.flagsmith-privateinstalled (--excludethe core one) → the 7 enterprise tools; verified both partials are Prettier-stable.tests/unit/api/test_generate_mcp_tool_catalogue.py): default rendering,--exclude, and pipe-escaping — all pass.