Installation

PwnDoc MCP Server can be installed through multiple methods depending on your platform and preferences.

Recommended: pip (Python Package)

The easiest way to install on any platform with Python:

# Basic installation
pip install pwndoc-mcp-server

# With CLI support (recommended)
pip install pwndoc-mcp-server[cli]

# With SSE transport support
pip install pwndoc-mcp-server[sse]

# Full installation with all features
pip install pwndoc-mcp-server[all]

# Development installation
pip install pwndoc-mcp-server[dev]

Verify Installation

pwndoc-mcp --version
pwndoc-mcp --help

Kali Linux Installation

If you encounter errors on Kali Linux, use a virtual environment:

sudo apt update
sudo apt install -y python3-venv
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install pwndoc-mcp-server

Docker

Pull the official image:

docker pull ghcr.io/walidfaour/pwndoc-mcp-server:latest

Or build from source:

git clone https://github.com/walidfaour/pwndoc-mcp-server.git
cd pwndoc-mcp-server
docker build -t pwndoc-mcp-server .

Run with Docker

docker run -it --rm \
  -e PWNDOC_URL=https://your-pwndoc-instance.com \
  -e PWNDOC_USERNAME=your-username \
  -e PWNDOC_PASSWORD=your-password \
  ghcr.io/walidfaour/pwndoc-mcp-server

Standalone Binary

Download pre-compiled binaries from GitHub Releases:

Linux (x64)

wget https://github.com/walidfaour/pwndoc-mcp-server/releases/latest/download/pwndoc-mcp-server-linux-x64
chmod +x pwndoc-mcp-server-linux-x64
sudo mv pwndoc-mcp-server-linux-x64 /usr/local/bin/pwndoc-mcp

macOS (x64)

curl -LO https://github.com/walidfaour/pwndoc-mcp-server/releases/latest/download/pwndoc-mcp-server-macos-x64
chmod +x pwndoc-mcp-server-macos-x64
sudo mv pwndoc-mcp-server-macos-x64 /usr/local/bin/pwndoc-mcp

Windows (x64)

Download pwndoc-mcp-server-windows-x64.exe from the releases page and add to your PATH.

System Packages

Debian/Ubuntu (apt)

# Download the .deb package
wget https://github.com/walidfaour/pwndoc-mcp-server/releases/latest/download/pwndoc-mcp-server_1.0.7_amd64.deb

# Install
sudo dpkg -i pwndoc-mcp-server_1.0.7_amd64.deb

# Or with apt (handles dependencies)
sudo apt install ./pwndoc-mcp-server_1.0.7_amd64.deb

RHEL/Fedora/CentOS (yum/dnf)

# Download the .rpm package
wget https://github.com/walidfaour/pwndoc-mcp-server/releases/latest/download/pwndoc-mcp-server-1.0.7-1.x86_64.rpm

# Install with yum
sudo yum localinstall pwndoc-mcp-server-1.0.7-1.x86_64.rpm

# Or with dnf
sudo dnf install ./pwndoc-mcp-server-1.0.7-1.x86_64.rpm

Homebrew (macOS)

# Add the tap
brew tap walidfaour/pwndoc

# Install
brew install pwndoc-mcp-server

Scoop (Windows)

# Add the bucket
scoop bucket add pwndoc https://github.com/walidfaour/scoop-pwndoc

# Install
scoop install pwndoc-mcp-server

From Source

Prerequisites

Python 3.8 or higher
pip
git

Steps

# Clone the repository
git clone https://github.com/walidfaour/pwndoc-mcp-server.git
cd pwndoc-mcp-server

# Create virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # Linux/macOS
# or: venv\Scripts\activate  # Windows

# Install in development mode
pip install -e ".[dev]"

# Verify installation
pwndoc-mcp --version

Requirements

Runtime Requirements

Requirement	Minimum Version
Python	3.8+
PwnDoc	3.0+

Python Dependencies

Automatically installed via pip:

httpx - Async HTTP client
pyyaml - YAML configuration
typer - CLI framework (with [cli])
rich - Terminal formatting (with [cli])
aiohttp - SSE transport (with [sse])

Next Steps

After installation: