Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 165 additions & 0 deletions INSTALLATION.md
Original file line number Diff line number Diff line change
@@ -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-<name>
```

### Python Servers (uvx/pip)

**Option 1: uvx (Recommended)**

No installation required:

```bash
uvx mcp-server-<name>
```

**Option 2: pip**

```bash
pip install mcp-server-<name>
python -m mcp_server_<name>
```

## 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": {
"<server-name>": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-<name>"]
}
}
}
```

**Python servers:**

```json
{
"mcpServers": {
"<server-name>": {
"command": "uvx",
"args": ["mcp-server-<name>"]
}
}
}
```

### 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": {
"<server-name>": {
"command": "npx",
"args": ["-y", "@modelcontextprotocol/server-<name>"]
}
}
}
```

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": {
"<server-name>": {
"command": {
"path": "uvx",
"args": ["mcp-server-<name>"]
}
}
}
}
```

### 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": {
"<server-name>": {
"command": "docker",
"args": ["run", "-i", "--rm", "mcp/<server-name>"]
}
}
}
```

## 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-<name>

# For TypeScript servers (npx)
npx @modelcontextprotocol/inspector npx -y @modelcontextprotocol/server-<name>
```

## 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
4 changes: 4 additions & 0 deletions src/everything/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down
2 changes: 2 additions & 0 deletions src/fetch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 4 additions & 0 deletions src/filesystem/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:

Expand Down
2 changes: 2 additions & 0 deletions src/git/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion src/memory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 4 additions & 0 deletions src/sequentialthinking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions src/time/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down