Installation
Get CodeWiki MCP running in under a minute.
Prerequisites
- Python 3.10+
- Playwright Chromium — installed automatically via
playwright install chromium
Option A — PyPI (recommended)
The simplest way. Install from PyPI and you get the codewiki-mcp command globally:
pip install codewiki-mcp
playwright install chromium
Verify it works:
codewiki-mcp --help
Option B — From Source
Clone the repository and install:
git clone https://github.com/Cloudmeru/CodeWiki-MCP.git
cd CodeWiki-MCP
pip install .
playwright install chromium
For development (includes pytest and test dependencies):
pip install -e ".[test]"
Option C — Docker
# Build the image
docker build -t codewiki-mcp .
# Run with stdio (for MCP clients)
docker run -it --rm codewiki-mcp
# Run with SSE (for HTTP access)
docker run -p 3000:3000 codewiki-mcp --sse --port 3000
# With custom config
docker run -e CODEWIKI_MAX_RETRIES=5 -e CODEWIKI_VERBOSE=true codewiki-mcp
CLI Options
codewiki-mcp [--stdio | --sse] [--port PORT] [--verbose | -v]
| Flag | Description |
|---|---|
--stdio | Run with stdio transport (default) |
--sse | Run with SSE transport |
--port PORT | Port for SSE transport (default: 3000) |
--verbose, -v | Enable debug logging |
Next Steps
Now connect it to your editor → Editor Setup