Skip to content
This repository was archived by the owner on Jun 30, 2026. It is now read-only.

docs: rewrite READMEs for archival posture#363

Merged
rwjblue-glean merged 1 commit into
mainfrom
rwjblue/docs-archive-readmes
Jun 30, 2026
Merged

docs: rewrite READMEs for archival posture#363
rwjblue-glean merged 1 commit into
mainfrom
rwjblue/docs-archive-readmes

Conversation

@rwjblue-glean

@rwjblue-glean rwjblue-glean commented Jun 29, 2026

Copy link
Copy Markdown
Member

BLUF: Rewrite README docs to direct users away from the local MCP server.

This repo is being archived because it predates Glean’s managed remote MCP server. The updated docs remove active install/configuration guidance and point users to the managed MCP server docs or Glean CLI instead.

Description

Rewrites the top-level README, @gleanwork/local-mcp-server README, and @gleanwork/mcp-server-utils README around the archival posture.

Related Issue

N/A — archival cleanup from the repository deprecation plan.

Motivation and Context

The old READMEs still presented the local MCP server as usable for experimental/testing workflows and included setup, Docker, and client configuration instructions. That creates the wrong expectation now that the supported path is the managed Glean MCP server.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Code refactoring
  • Build/CI pipeline changes
  • Other (please describe):

How Has This Been Tested?

  • Unit tests
  • Integration tests
  • Manual testing
  • Other (please describe): npm exec -- prettier --check README.md packages/local-mcp-server/README.md packages/mcp-server-utils/README.md

Checklist

  • My code follows the code style of this project
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have checked for potential breaking changes and addressed them

Screenshots (if appropriate)

N/A

Additional Notes

The utils README now mirrors the same archival/deprecated posture as the other READMEs. This PR only updates repository documentation; npm package deprecation for @gleanwork/mcp-server-utils is intentionally handled separately after follow-up dependency cleanup.

The local MCP server is no longer the supported path for MCP usage now
that Glean provides a managed remote MCP server.

Replace active install and configuration guidance with archive status,
migration links, and historical context so new users are directed toward
the managed MCP server or Glean CLI instead.
@rwjblue-glean rwjblue-glean force-pushed the rwjblue/docs-archive-readmes branch from 4a49b14 to 352f236 Compare June 29, 2026 22:50
@rwjblue-glean rwjblue-glean marked this pull request as ready for review June 30, 2026 15:16
@rwjblue-glean rwjblue-glean requested a review from a team as a code owner June 30, 2026 15:16
@rwjblue-glean rwjblue-glean merged commit 2cc4723 into main Jun 30, 2026
5 checks passed
@rwjblue-glean rwjblue-glean deleted the rwjblue/docs-archive-readmes branch June 30, 2026 15:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant