From 2ebada88a084a57f1a819de304f3fd5ad9cd71ee Mon Sep 17 00:00:00 2001 From: Robert Jackson Date: Mon, 6 Apr 2026 17:20:40 -0400 Subject: [PATCH] docs: use GitHub warning admonition in READMEs 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. --- README.md | 3 +++ packages/local-mcp-server/README.md | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index effb8dc5..74055fa2 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ [![npm version](https://badge.fury.io/js/@gleanwork%2Fmcp-server.svg)](https://badge.fury.io/js/@gleanwork%2Fmcp-server) [![License](https://img.shields.io/npm/l/@gleanwork%2Fmcp-server.svg)](https://github.com/gleanwork/mcp-server/blob/main/LICENSE) +> [!WARNING] +> We recommend using the [remote MCP server integrated directly in Glean](https://docs.glean.com/administration/platform/mcp/about) 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. + This monorepo contains packages for Glean's local MCP server. For more details see the READMEs of the individual packages. - [@gleanwork/configure-mcp-server](https://github.com/gleanwork/configure-mcp-server) for configuring the local MCP server with popular MCP clients. diff --git a/packages/local-mcp-server/README.md b/packages/local-mcp-server/README.md index 59b3f46f..321dbe7d 100644 --- a/packages/local-mcp-server/README.md +++ b/packages/local-mcp-server/README.md @@ -5,7 +5,8 @@ [![npm version](https://badge.fury.io/js/@gleanwork%2Flocal-mcp-server.svg)](https://badge.fury.io/js/@gleanwork%2Flocal-mcp-server) [![License](https://img.shields.io/npm/l/@gleanwork%2Fmcp-server.svg)](https://github.com/gleanwork/mcp-server/blob/main/LICENSE) -> **Note:** We recommend using the [remote MCP server integrated directly in Glean](https://docs.glean.com/administration/platform/mcp/about-glean-mcp-integration) 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. +> [!WARNING] +> We recommend using the [remote MCP server integrated directly in Glean](https://docs.glean.com/administration/platform/mcp/about) 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. The Glean MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides seamless integration with Glean's enterprise knowledge.