Skip to content

Conversation

@sudoingX
Copy link

@sudoingX sudoingX commented Dec 8, 2025

Summary

Creates a central INSTALLATION.md and updates all server READMEs to reference it, addressing documentation drift concerns raised in #2956.

Changes

  • New: INSTALLATION.md - Central installation guide covering:

    • Quick reference table for all 7 servers
    • TypeScript (npx) vs Python (uvx/pip) installation patterns
    • Client configurations (Claude Desktop, VS Code, Zed, Zencoder)
    • Docker patterns
    • Debugging with MCP Inspector
  • Updated: All 7 server READMEs with reference link to central guide:

    • src/everything/README.md
    • src/fetch/README.md
    • src/filesystem/README.md
    • src/git/README.md
    • src/memory/README.md
    • src/sequentialthinking/README.md
    • src/time/README.md

Why This Approach

Per @domdomegg's comment in #2956: standardization prevents documentation drift where some apps have outdated setup steps compared to others.

This is a "light touch" approach that:

  1. Creates a single source of truth for common installation patterns
  2. Keeps server-specific details in their individual READMEs
  3. Minimizes review burden
  4. Can be extended in future PRs for fuller README standardization

Testing

  • Verified all relative links resolve correctly (../INSTALLATION.md)
  • Checked markdown renders properly
  • No existing content removed

Fixes #3064

- Create central INSTALLATION.md with unified patterns
- Add references from all server READMEs
- Covers TypeScript (npx) and Python (uvx/pip) servers
- Documents Claude Desktop, VS Code, Zed, Zencoder, and Docker

Fixes modelcontextprotocol#3064
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Standardize the install instructions across the apps

1 participant