Skip to content

Installation

Jump to bottom
Cameron Rye edited this page Nov 16, 2025 · 1 revision

Installation Guide

This guide covers all installation methods for the Gopher & Gemini MCP Server across different platforms.

Prerequisites

Installation Methods

Option 1: Development Installation (Recommended)

Best for developers and contributors who want to modify the code or stay on the latest version.

# Clone the repository
git clone https://github.com/cameronrye/gopher-mcp.git
cd gopher-mcp

# Set up development environment
./scripts/dev-setup.sh  # Unix/macOS
# or
scripts\dev-setup.bat   # Windows

# Run the server
uv run task serve

Option 2: PyPI Installation

Best for end users who want a stable release.

# Install from PyPI
pip install gopher-mcp

# Or with uv
uv add gopher-mcp

Option 3: GitHub Installation

Install directly from the GitHub repository.

# Install from GitHub
uv add git+https://github.com/cameronrye/gopher-mcp.git

# Or install in development mode
git clone https://github.com/cameronrye/gopher-mcp.git
cd gopher-mcp
uv sync --all-extras

Platform-Specific Instructions

Windows

# Clone the repository
git clone https://github.com/cameronrye/gopher-mcp.git
cd gopher-mcp

# Run the setup script
scripts\dev-setup.bat

# Run the server
uv run task serve

macOS

# Clone the repository
git clone https://github.com/cameronrye/gopher-mcp.git
cd gopher-mcp

# Run the setup script
./scripts/dev-setup.sh

# Run the server
uv run task serve

Linux

# Clone the repository
git clone https://github.com/cameronrye/gopher-mcp.git
cd gopher-mcp

# Run the setup script
./scripts/dev-setup.sh

# Run the server
uv run task serve

Claude Desktop Integration

Configuration File Location

macOS:

~/Library/Application Support/Claude/claude_desktop_config.json

Windows:

%APPDATA%\Claude\claude_desktop_config.json

Linux:

~/.config/Claude/claude_desktop_config.json

Configuration

Add the following to your claude_desktop_config.json:

Unix/macOS/Linux:

{
  "mcpServers": {
    "gopher": {
      "command": "uv",
      "args": ["--directory", "/path/to/gopher-mcp", "run", "task", "serve"],
      "env": {
        "MAX_RESPONSE_SIZE": "1048576",
        "TIMEOUT_SECONDS": "30"
      }
    }
  }
}

Windows:

{
  "mcpServers": {
    "gopher": {
      "command": "uv",
      "args": [
        "--directory",
        "C:\\path\\to\\gopher-mcp",
        "run",
        "task",
        "serve"
      ],
      "env": {
        "MAX_RESPONSE_SIZE": "1048576",
        "TIMEOUT_SECONDS": "30"
      }
    }
  }
}

Verification

After installation, verify the setup:

# Run quality checks
uv run task quality

# Run tests
uv run task test

# Start the server
uv run task serve

Next Steps

Made with ❤️ by Cameron Rye

Clone this wiki locally