Fast: For casual inquiries, this tool defaults to intro mode when fetching an article, which allows you LLM to provide quick yet factual responses. If the LLM needs more context, it will call the tool in either full or refs mode to get the full article or the references section. Additionally, this tool uses cheerio to strip away unnecessary HTML elements, significantly reducing prompt processing times.

Low Overhead: Unlike RAG-based semantic search, this tool does not require a vector database. It interacts directly with your self-hosted Kiwix endpoint via its OPDS API. Since the vast majority of the content resides on disk, this minimal overhead makes it possible to implement on SBCs / mobile devices.

Limitations

Currently does not support images.

Installation & Configuration

For a more detailed installation guide with pictures, visit the GitHub repository.

1. Download Kiwix

Kiwix Desktop (Recommended for beginners):

Windows: Download Kiwix and install.
macOS: Same as Windows. Alternatively, you can get it from the Mac App Store.
Linux: Install kiwix-desktop via your package manager or from Flathub.

Setup: Once Kiwix is installed, navigate to "Online Files" to download your desired wiki dumps (e.g., Wikipedia, ArchWiki). Select "Local Kiwix Server" from the drop-down menu in the top-right corner (or press Ctrl+I). Set the address to 127.0.0.1 on port 8080 and start the server.

Note: If non-Wikipedia books do not appear in your book list (a known bug), use Kiwix Server instead.

Kiwix Server (Recommended for headless systems / SBCs):

Windows & macOS: Download Kiwix Server and install.
Linux: Install kiwix-tools via your package manager.

Setup:

Download your desired wiki dumps here.
Navigate to the directory containing your openZIM files and run:

You may also pass the -d flag to run the server as a background daemon.

2. Download and Configure this Tool

Terminal Setup: Assuming you did not uncheck the "add lms to your PATH" option during LM Studio's setup, run:

Tool Activation:

Once installed, click the sidebar button in the top-right corner of the LM Studio UI.
Enable this tool.
You may also adjust its configurations (mainly search/fetch limiters) in the drop-down menu if needed.

Your LLM is now ready to read articles from your Kiwix library!

Credits

This tool is a fork of lmstudio/wikipedia and is mainly authored/enhanced by Deepseek-V4 and Deepseek-V3.3, with the code audited by me.

Disclaimer: This is just a for-fun weekend project and should NOT be used in production environments. This tool is provided "as is" with NO WARRANTY.

Feedbacks and contributions to this project are welcome! :D

License

This tool is released under the GPLv3 license.

kiwix-serve -i 127.0.0.1 -p 8080 *.zim

lms get 2vibeornot2vibe/localwiki