io.github.cameronrye/openzim-mcp

Offline MCP access to ZIM knowledge archives — Wikipedia, Wiktionary, Stack Exchange, Kiwix.

io.github.cameronrye/openzim-mcp · Repository · version 2.5.1 · 105 stars · listed from registry

Install

The sweep installs into a clean prefix, but this is the command a user would run:

uvx openzim-mcp

Results by platform

Linux

needs configuration2026-08-16 · probed over pypi

1 recorded run, oldest first.

handshake failed: MCP error -32000: Connection closed
--- stderr (tail) ---
Downloading libzim (8.0MiB)
 Downloaded libzim
Installed 46 packages in 50ms
usage: openzim-mcp [-h] [--mode {simple,advanced}]
                   [--transport {stdio,http,sse}] [--host HOST] [--port PORT]
                   directories [directories ...]

OpenZIM MCP Server - Access ZIM files through MCP

positional arguments:
  directories           One or more directories containing ZIM files

options:
  -h, --help            show this help message and exit
  --mode {simple,advanced}
                        Tool mode: 'advanced' for all 8 tools, 'simple' for 1
                        intelligent NL tool (default: simple, or from
                        OPENZIM_MCP_TOOL_MODE env var)
  --transport {stdio,http,sse}
                        Transport: 'stdio' (default, for local MCP clients),
                        'http' (streamable HTTP), or 'sse' (legacy SSE — no
                        auth middleware, localhost only). Env:
                        OPENZIM_MCP_TRANSPORT
  --host HOST           HTTP/SSE bind host (default 127.0.0.1). Env:
                        OPENZIM_MCP_HOST
  --port PORT           HTTP/SSE bind port (default 8000). Env:
                        OPENZIM_MCP_PORT

Examples:
  # Simple mode (default - 1 intelligent NL tool)
  python -m openzim_mcp /path/to/zim/files
  python -m openzim_mcp --mode simple /path/to/zim/files

  # Advanced mode (all 8 tools)
  python -m openzim_mcp --mode advanced /path/to/zim/files

Environment Variables:
  OPENZIM_MCP_TOOL_MODE - Set tool mode (advanced or simple)

macOS

needs configuration2026-08-16 · probed over pypi

1 recorded run, oldest first.

handshake failed: MCP error -32000: Connection closed
--- stderr (tail) ---
Downloading libzim (3.4MiB)
 Downloaded libzim
Installed 46 packages in 335ms
usage: openzim-mcp [-h] [--mode {advanced,simple}]
                   [--transport {stdio,http,sse}] [--host HOST] [--port PORT]
                   directories [directories ...]

OpenZIM MCP Server - Access ZIM files through MCP

positional arguments:
  directories           One or more directories containing ZIM files

options:
  -h, --help            show this help message and exit
  --mode {advanced,simple}
                        Tool mode: 'advanced' for all 8 tools, 'simple' for 1
                        intelligent NL tool (default: simple, or from
                        OPENZIM_MCP_TOOL_MODE env var)
  --transport {stdio,http,sse}
                        Transport: 'stdio' (default, for local MCP clients),
                        'http' (streamable HTTP), or 'sse' (legacy SSE — no
                        auth middleware, localhost only). Env:
                        OPENZIM_MCP_TRANSPORT
  --host HOST           HTTP/SSE bind host (default 127.0.0.1). Env:
                        OPENZIM_MCP_HOST
  --port PORT           HTTP/SSE bind port (default 8000). Env:
                        OPENZIM_MCP_PORT

Examples:
  # Simple mode (default - 1 intelligent NL tool)
  python -m openzim_mcp /path/to/zim/files
  python -m openzim_mcp --mode simple /path/to/zim/files

  # Advanced mode (all 8 tools)
  python -m openzim_mcp --mode advanced /path/to/zim/files

Environment Variables:
  OPENZIM_MCP_TOOL_MODE - Set tool mode (advanced or simple)

Windows

needs configuration2026-08-16 · probed over pypi

1 recorded run, oldest first.

handshake failed: MCP error -32000: Connection closed
--- stderr (tail) ---
Downloading libzim (15.2MiB)
 Downloaded libzim
Installed 48 packages in 8.97s
usage: openzim-mcp [-h] [--mode {advanced,simple}]
                   [--transport {stdio,http,sse}] [--host HOST] [--port PORT]
                   directories [directories ...]

OpenZIM MCP Server - Access ZIM files through MCP

positional arguments:
  directories           One or more directories containing ZIM files

options:
  -h, --help            show this help message and exit
  --mode {advanced,simple}
                        Tool mode: 'advanced' for all 8 tools, 'simple' for 1
                        intelligent NL tool (default: simple, or from
                        OPENZIM_MCP_TOOL_MODE env var)
  --transport {stdio,http,sse}
                        Transport: 'stdio' (default, for local MCP clients),
                        'http' (streamable HTTP), or 'sse' (legacy SSE � no
                        auth middleware, localhost only). Env:
                        OPENZIM_MCP_TRANSPORT
  --host HOST           HTTP/SSE bind host (default 127.0.0.1). Env:
                        OPENZIM_MCP_HOST
  --port PORT           HTTP/SSE bind port (default 8000). Env:
                        OPENZIM_MCP_PORT

Examples:
  # Simple mode (default - 1 intelligent NL tool)
  python -m openzim_mcp /path/to/zim/files
  python -m openzim_mcp --mode simple /path/to/zim/files

  # Advanced mode (all 8 tools)
  python -m openzim_mcp --mode advanced /path/to/zim/files

Environment Variables:
  OPENZIM_MCP_TOOL_MODE - Set tool mode (advanced or simple)

Badge

Paste this into the project README to show the current result:

[![does it install](https://img.shields.io/endpoint?url=https://doesitinstall.com/badge/io.github.cameronrye__openzim-mcp.json)](https://doesitinstall.com/s/io.github.cameronrye__openzim-mcp.html)