Enables interaction with Kiwix HTTP servers to browse available ZIM library books, perform full-text searches across offline content, and retrieve articles as plain text.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type @ followed by the MCP server name and your instructions, e.g., "@kiwix-mcp search for 'quantum physics' in the Wikipedia book"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
MCP server and Python client library for Kiwix HTTP servers.
Tested against kiwix-tools (Debian bookworm package) and newer libkiwix-based deployments. Any standard kiwix-serve deployment should work.
Known quirks handled transparently:
kiwix-serve emits unescaped & in OPDS catalog href attributes
Newer servers require a book scope when the library spans multiple languages — the client returns a clear error with instructions in that case
Newer servers use a path-prefixed URL scheme (e.g. /kiwix/content/book_slug) — slug and article URL handling adapts automatically
Related MCP server: openzim-mcp
Tool | Description |
| List available ZIM books; optional title filter |
| Full-text search across all books or a specific book |
| Fetch an article as plain text by URL |
pip install kiwix-mcpOr with uv:
uv pip install kiwix-mcpkiwix-mcp --base-url http://localhost:8080
# or
KIWIX_BASE_URL=http://localhost:8080 kiwix-mcpClaude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"kiwix": {
"command": "kiwix-mcp",
"args": ["--base-url", "http://localhost:8080"]
}
}
}Claude Code — add at user scope so it's available in all projects:
claude mcp add --scope user --transport http kiwix https://your-kiwix-mcp-host/mcp/kiwix-mcp --transport sse --base-url http://localhost:8080Then point your MCP client at http://localhost:8000/sse.
kiwix-mcp --transport streamable-http --base-url http://localhost:8080Then point your MCP client at http://localhost:8000/mcp.
When using HTTP transports with browser-based MCP clients (e.g. llama-server WebUI), CORS headers are added automatically. By default all origins are allowed.
To restrict allowed origins:
kiwix-mcp --transport streamable-http --base-url http://localhost:8080 \
--cors-allow-origins "http://localhost:3000,http://myapp.example.com"
# or
CORS_ALLOW_ORIGINS="http://localhost:3000" kiwix-mcp --transport streamable-http --base-url http://localhost:8080CORS has no effect on stdio transport.
docker run -e KIWIX_BASE_URL=http://your-kiwix-server:8080 \
-p 8000:8000 \
oscillatelabs/kiwix-mcpDefaults to streamable-http transport bound on 0.0.0.0:8000. Override with env vars:
docker run \
-e KIWIX_BASE_URL=http://your-kiwix-server:8080 \
-e TRANSPORT=sse \
-e HOST=0.0.0.0 \
-e PORT=8000 \
-e CORS_ALLOW_ORIGINS="http://localhost:3000" \
-p 8000:8000 \
oscillatelabs/kiwix-mcpFlag | Default | Env |
| — |
|
|
|
|
|
|
|
|
|
|
|
|
|
from kiwix_client import KiwixClient, strip_html
c = KiwixClient("http://localhost:8080")
# List all books
books = c.list_books()
# Filter by title keyword
books = c.list_books(q="wikipedia")
# Search
sr = c.search("query")
# Search within a specific book
sr = c.search("query", books="devdocs_en_rust_2025-10")
# Fetch article as plain text
html = c.fetch_article(sr.results[0].url)
plain = strip_html(html)kiwix-serve exposes three HTTP surfaces used by this client:
OPDS catalog (/catalog/v2/entries) — Atom XML with book metadata and slugs; supports ?q=, ?count=, ?start= params
Full-text search (/search?pattern=…&books.name=…&start=…) — HTML; 25 results/page; books.name= scopes to a specific ZIM slug
Articles (/{book_slug}/A/{path}) — HTML; use strip_html for plain text
There is no JSON API. Full-text search requires ZIMs built with _ftindex:yes — not all ZIMs include it. Servers with books spanning multiple languages require a book scope for any search request.
# Install with dev dependencies
pip install -e ".[dev]"
# Run the test suite (no network required)
pytestFetch an article from the Kiwix server and return its content as plain text. Use the URL field from kiwix_search results.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes |
| Name | Required | Description |
|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided. Description only states it returns plain text, missing details like error handling, size limits, or rate limits. Significant gap for a tool with no annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences: first states purpose, second gives usage hint. No wasted words, front-loaded with key information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Tool is simple with one param and output schema (signal true). Description covers usage and purpose adequately, but lacks behavioral details. Still acceptable for a straightforward tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter 'url' with 0% schema coverage. Description adds context: URL must come from kiwix_search results, which provides semantic meaning beyond schema type.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states verb (fetch), resource (article), and output format (plain text). Also ties to sibling tool via 'URL field from kiwix_search results', differentiating it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs to use URL from kiwix_search results, which guides when to use. Lacks explicit when-not-to-use or alternatives, but context is sufficient.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
List ZIM books available on the Kiwix server. Optionally filter by title keyword.
| Name | Required | Description | Default |
|---|---|---|---|
| query | No |
| Name | Required | Description |
|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden. It states a simple read operation ('List') and optional filtering, but lacks details on performance, pagination, or error behavior. Adequate for a straightforward list.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, front-loaded sentence with no redundant words. Every part is essential: action, resource, context, and parameter hint.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple tool with one optional parameter and an output schema, the description is sufficient. It could mention that it returns a list of books, but the output schema likely covers that.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema has 0% description coverage; the description adds that the 'query' parameter filters by title keyword, providing basic meaning. However, it doesn't explain matching behavior (case sensitivity, partial match).
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states 'List ZIM books available on the Kiwix server' with an action verb and specific resource. It distinguishes from siblings like kiwix_search and kiwix_fetch_article, which have different purposes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage for listing books but does not explicitly state when to use this tool vs alternatives (kiwix_search, kiwix_fetch_article). No exclusion criteria or context provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Full-text search across Kiwix ZIM books. Returns article titles, snippets, and URLs. Use kiwix_fetch_article to retrieve full content.
| Name | Required | Description | Default |
|---|---|---|---|
| book | No | ||
| query | Yes | ||
| start | No |
| Name | Required | Description |
|---|---|---|
| result | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations provided, but description indicates read-only search operation (returns results, no side effects). Does not detail limitations or edge cases, but adequately transparent for a simple search tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences covering purpose, output, and next step. Extremely concise with no irrelevant information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Tool has 3 parameters and no annotations; description lacks details on pagination (start) and book selection. Output schema may cover returns, but incomplete for parameter context. Adequate but with gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0%, and description provides no explanation for the three parameters (query, book, start). Names alone are insufficient; agent cannot infer valid values or usage for 'book' and 'start'.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description states 'Full-text search across Kiwix ZIM books' with a specific verb and resource, and lists return items (titles, snippets, URLs), distinguishing from siblings by mentioning alternative tool for full content.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly recommends using kiwix_fetch_article for full content, providing guidance on when to use alternatives. Lacks explicit 'when not to use' but clearly directs to sibling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
v1.5.1kiwix_list_booksv1.4.1kiwix_list_booksv1.3.0kiwix_fetch_articlekiwix_list_bookskiwix_searchScored across 3 tools
Each tool has a distinct purpose: listing books, full-text search, and fetching articles. No overlap in functionality.
All tools share the 'kiwix_' prefix and follow a verb_noun pattern (list_books, search, fetch_article), ensuring predictable naming.
With only 3 tools, the set is minimal but covers the core read-only workflow for a Kiwix ZIM server. Slightly low but not deficient.
The tools cover the essential operations: listing available books, searching within them, and retrieving full articles. Missing book metadata or browsing, but acceptable for a basic reader.
MCP server for Russian books search, details, and recommendation candidates.
Read-only MCP server exposing a user ORANO library to their own AI agent.
MCP server for Project Gutenberg — 75,000+ public-domain ebooks with full plain-text retrieval.
