From 800e05ba27c9c87a2064367d147cfe9ee538dc24 Mon Sep 17 00:00:00 2001 From: "Xpress AI (Dip KD)" Date: Mon, 8 Dec 2025 13:54:34 +0700 Subject: [PATCH] docs: standardize installation instructions (#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 #3064 --- INSTALLATION.md | 165 +++++++++++++++++++++++++++++++ src/everything/README.md | 4 + src/fetch/README.md | 2 + src/filesystem/README.md | 4 + src/git/README.md | 2 + src/memory/README.md | 6 +- src/sequentialthinking/README.md | 4 + src/time/README.md | 2 + 8 files changed, 188 insertions(+), 1 deletion(-) create mode 100644 INSTALLATION.md diff --git a/INSTALLATION.md b/INSTALLATION.md new file mode 100644 index 0000000000..61a97f3c6b --- /dev/null +++ b/INSTALLATION.md @@ -0,0 +1,165 @@ +# MCP Servers Installation Guide + +This guide provides standardized installation instructions for all MCP servers in this repository. + +## Quick Reference + +| Server | Type | Primary Install | +|--------|------|-----------------| +| everything | TypeScript | `npx -y @modelcontextprotocol/server-everything` | +| fetch | Python | `uvx mcp-server-fetch` | +| filesystem | TypeScript | `npx -y @modelcontextprotocol/server-filesystem` | +| git | Python | `uvx mcp-server-git` | +| memory | TypeScript | `npx -y @modelcontextprotocol/server-memory` | +| sequentialthinking | TypeScript | `npx -y @modelcontextprotocol/server-sequential-thinking` | +| time | Python | `uvx mcp-server-time` | + +## Installation Methods + +### TypeScript Servers (NPX) + +No installation required. Use `npx` to run directly: + +```bash +npx -y @modelcontextprotocol/server- +``` + +### Python Servers (uvx/pip) + +**Option 1: uvx (Recommended)** + +No installation required: + +```bash +uvx mcp-server- +``` + +**Option 2: pip** + +```bash +pip install mcp-server- +python -m mcp_server_ +``` + +## Client Configuration + +### Claude Desktop + +Add to your `claude_desktop_config.json`: + +- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` +- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` + +**TypeScript servers:** + +```json +{ + "mcpServers": { + "": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-"] + } + } +} +``` + +**Python servers:** + +```json +{ + "mcpServers": { + "": { + "command": "uvx", + "args": ["mcp-server-"] + } + } +} +``` + +### VS Code + +**One-click install:** Use the install buttons in each server's README. + +**Manual - User Settings:** + +1. Open User Settings (JSON) via Command Palette +2. Add the `mcp.servers` configuration + +**Manual - Workspace Configuration:** + +Create `.vscode/mcp.json` in your workspace: + +```json +{ + "servers": { + "": { + "command": "npx", + "args": ["-y", "@modelcontextprotocol/server-"] + } + } +} +``` + +For more details, see the [VS Code MCP documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). + +### Zed + +Add to Zed settings (`~/.config/zed/settings.json`): + +```json +{ + "context_servers": { + "": { + "command": { + "path": "uvx", + "args": ["mcp-server-"] + } + } + } +} +``` + +### Zencoder + +1. Open the Zencoder menu (...) +2. Select **Agent Tools** +3. Click **Add Custom MCP** +4. Add your server configuration and click **Install** + +## Docker + +All servers support Docker installation. See individual server READMEs for specific mount requirements and build instructions. + +General pattern for Claude Desktop: + +```json +{ + "mcpServers": { + "": { + "command": "docker", + "args": ["run", "-i", "--rm", "mcp/"] + } + } +} +``` + +## Debugging + +Use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) to debug server connections: + +```bash +# For Python servers (uvx) +npx @modelcontextprotocol/inspector uvx mcp-server- + +# For TypeScript servers (npx) +npx @modelcontextprotocol/inspector npx -y @modelcontextprotocol/server- +``` + +## Server-Specific Configuration + +Each server may have additional configuration options. See the individual server README for: + +- Required arguments (e.g., repository paths, allowed directories) +- Environment variables +- Docker volume mounts +- Server-specific features and tools diff --git a/src/everything/README.md b/src/everything/README.md index 35274f617b..f87742fab4 100644 --- a/src/everything/README.md +++ b/src/everything/README.md @@ -162,6 +162,10 @@ The server sends random-leveled log messages every 15 seconds, e.g.: } ``` +## Installation + +> For detailed installation instructions across all clients and methods, see the [Installation Guide](../INSTALLATION.md). + ## Usage with Claude Desktop (uses [stdio Transport](https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio)) Add to your `claude_desktop_config.json`: diff --git a/src/fetch/README.md b/src/fetch/README.md index 2c3e048927..d2b6383604 100644 --- a/src/fetch/README.md +++ b/src/fetch/README.md @@ -26,6 +26,8 @@ The fetch tool will truncate the response, but by using the `start_index` argume ## Installation +> For standardized installation patterns across all MCP servers, see the [Installation Guide](../INSTALLATION.md). + Optionally: Install node.js, this will cause the fetch server to use a different HTML simplifier that is more robust. ### Using uv (recommended) diff --git a/src/filesystem/README.md b/src/filesystem/README.md index e9ddc2b1e2..a0ee3692ce 100644 --- a/src/filesystem/README.md +++ b/src/filesystem/README.md @@ -204,6 +204,10 @@ The mapping for filesystem tools is: > Note: `idempotentHint` and `destructiveHint` are meaningful only when `readOnlyHint` is `false`, as defined by the MCP spec. +## Installation + +> For detailed installation instructions across all clients and methods, see the [Installation Guide](../INSTALLATION.md). + ## Usage with Claude Desktop Add this to your `claude_desktop_config.json`: diff --git a/src/git/README.md b/src/git/README.md index cdc77daa1b..5e805f50ce 100644 --- a/src/git/README.md +++ b/src/git/README.md @@ -98,6 +98,8 @@ Please note that mcp-server-git is currently in early development. The functiona ## Installation +> For standardized installation patterns across all MCP servers, see the [Installation Guide](../INSTALLATION.md). + ### Using uv (recommended) When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will diff --git a/src/memory/README.md b/src/memory/README.md index dcc8116156..075cd62933 100644 --- a/src/memory/README.md +++ b/src/memory/README.md @@ -125,7 +125,11 @@ Example: - Relations between requested entities - Silently skips non-existent nodes -# Usage with Claude Desktop +## Installation + +> For detailed installation instructions across all clients and methods, see the [Installation Guide](../INSTALLATION.md). + +## Usage with Claude Desktop ### Setup diff --git a/src/sequentialthinking/README.md b/src/sequentialthinking/README.md index 322ded2726..ed8b34f60e 100644 --- a/src/sequentialthinking/README.md +++ b/src/sequentialthinking/README.md @@ -37,6 +37,10 @@ The Sequential Thinking tool is designed for: - Tasks that need to maintain context over multiple steps - Situations where irrelevant information needs to be filtered out +## Installation + +> For detailed installation instructions across all clients and methods, see the [Installation Guide](../INSTALLATION.md). + ## Configuration ### Usage with Claude Desktop diff --git a/src/time/README.md b/src/time/README.md index 93d6fcab89..c04744ec41 100644 --- a/src/time/README.md +++ b/src/time/README.md @@ -18,6 +18,8 @@ A Model Context Protocol server that provides time and timezone conversion capab ## Installation +> For standardized installation patterns across all MCP servers, see the [Installation Guide](../INSTALLATION.md). + ### Using uv (recommended) When using [`uv`](https://docs.astral.sh/uv/) no specific installation is needed. We will