🚀 Built for LLM Intelligence

Transform Static ZIM Archives into Dynamic Knowledge Engines

OpenZIM MCP is a modern, secure MCP server that enables AI models to access and search ZIM format knowledge bases offline with intelligent, structured access patterns.

⚡ Get Started 📖 View on GitHub

90%+

Test Coverage

🔒

Security First

⚡

High Performance

MCP Configuration

{
  "openzim-mcp": {
    "command": "uv",
    "args": [
      "--directory", "/path/to/openzim-mcp",
      "run", "python", "-m", "openzim_mcp",
      "/path/to/zim/files"
    ]
  }
}

Why LLMs Love OpenZIM MCP

Unlike basic file readers, OpenZIM MCP provides intelligent, structured access that LLMs need to effectively navigate and understand vast knowledge repositories.

🧭

Smart Navigation

Browse by namespace (articles, metadata, media) instead of blind searching. Get structured access to content organization.

🔍

Context-Aware Discovery

Get article structure, relationships, and metadata for deeper understanding. Extract links and content connections.

🎯

Intelligent Search

Advanced filtering, auto-complete suggestions, and relevance-ranked results with namespace and content type filters.

⚡

Performance Optimized

Cached operations and pagination prevent timeouts on massive archives. Intelligent caching with TTL management.

🔗

Relationship Mapping

Extract internal/external links to understand content connections. Build knowledge graphs from ZIM content.

🔒

Security First

Comprehensive input validation, path traversal protection, and secure resource management with type safety.

Quick Installation

Get up and running with OpenZIM MCP in just a few minutes.

Clone & Install

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

# Install dependencies
uv sync

Prepare ZIM Files

# Create directory for ZIM files
mkdir ~/zim-files

# Download ZIM files from Kiwix Library
# https://browse.library.kiwix.org/

Run the Server

# Start the MCP server
uv run python -m openzim_mcp /path/to/zim/files

# Or using make
make run ZIM_DIR=/path/to/zim/files

Usage Examples

See OpenZIM MCP in action with real-world examples and API calls.

Search ZIM Files

{
  "name": "search_zim_file",
  "arguments": {
    "zim_file_path": "wikipedia_en_100_2025-08.zim",
    "query": "artificial intelligence",
    "limit": 5
  }
}

Response:

Found 42 matches for "artificial intelligence", showing 1-5:

## 1. Artificial Intelligence
Path: Artificial_intelligence
Snippet: Artificial intelligence (AI) is intelligence demonstrated by machines...

## 2. Machine Learning  
Path: Machine_learning
Snippet: Machine learning is a subset of artificial intelligence...