docs: make local MCP server warning more visible#349
Merged
Conversation
Use GitHub's blockquote alert syntax (> [!WARNING]) to make the recommendation to use the remote MCP server more visually prominent. Also add the same warning to the top-level repo README.
rwjblue-glean
force-pushed
the
rwjblue/docs-readme-warning-admonition
branch
from
26c7c58 to
2ebada8
Compare
rwjblue-glean
changed the title
3 tasks
chris-freeman-glean
approved these changes
Apr 6, 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
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.
Description
Use GitHub's
> [!WARNING]blockquote alert syntax to make the "use the remote MCP server" recommendation visually prominent in both READMEs. Also adds the same warning to the top-level repo README, which previously lacked it.Here's how it renders:
Warning
We recommend using the remote MCP server integrated directly in Glean instead of this local MCP server. The remote server provides a more seamless experience with automatic updates, better performance, and simplified configuration. This local MCP server is primarily intended for experimental and testing purposes.
Type of Change
How Has This Been Tested?
Checklist
Stack