🐲📚 Librovore - CLI and MCP server for consuming documentation.
Project description
🐲📚 Documentation Search Engine - An intelligent documentation search and extraction tool that provides both a command-line interface for humans and an MCP (Model Context Protocol) server for AI agents. Search across Sphinx and MkDocs sites with fuzzy matching, extract clean markdown content, and integrate seamlessly with AI development workflows.
Key Features ⭐
🔍 Universal Search: Fuzzy, exact, and regex search across documentation inventories and full content
🤖 AI Agent Ready: Built-in MCP server for seamless integration with Claude Code and other AI tools
📖 Multi-Format Support: Works with Sphinx (Furo, ReadTheDocs themes) and MkDocs (Material theme) sites
🚀 High Performance: In-memory caching with sub-second response times for repeated queries
🧹 Clean Output: High-quality HTML-to-Markdown conversion preserving code blocks and formatting
🎯 Auto-Detection: Automatically identifies documentation type without manual configuration
🔌 Extensible: Plugin architecture supports additional documentation formats via extension manager
Installation 📦
Method: MCP Server Configuration
Add as an MCP server in your AI client configuration. For example, in Claude Code’s MCP configuration:
{
"mcpServers": {
"librovore": {
"command": "uvx",
"args": [
"librovore",
"serve"
]
}
}
}
Method: Download Standalone Executable
Download the latest standalone executable for your platform from GitHub Releases. These executables have no dependencies and work out of the box.
Method: Install Executable Script
Install via the uv tool command:
uv tool install librovore
or, run directly with uvx:
uvx librovore
Or, install via pipx:
pipx install librovore
Method: Install Python Package
Install via uv pip command:
uv pip install librovore
Or, install via pip:
pip install librovore
Examples 💡
Command-Line Interface
Search Python documentation for ‘pathlib’:
librovore query-inventory https://docs.python.org/3 pathlib
Search content with fuzzy matching:
librovore query-content https://fastapi.tiangolo.com "dependency injection"
MCP Server for AI Agents
Start the MCP server for AI agent integration:
librovore serve
The server provides tools for AI agents to search documentation object inventories, search full documentation content with snippets, and get overviews of available documentation.
Use Cases
AI Development: Enable Claude Code and other AI agents to search technical documentation
Documentation Research: Quickly find API references and usage examples across multiple sites
Development Workflows: Access documentation programmatically during development
Cross-Reference Search: Find related concepts across different documentation sources
About the Name 📝
The name “librovore” draws from Latin roots meaning “book-devourer” - a fitting metaphor for a tool that consumes and digests documentation across multiple formats:
🐲 The “Book Wyrm” - traditionally “librovore” is a synonym for “bookworm”, but Claude’s choice of the dragon emoji 🐲 rather than a worm emoji transformed our humble bookworm into a legendary wyrm that devours knowledge and makes it accessible
📖 Both “worm” and “wyrm” share the same Old English origins, so the linguistic evolution fits perfectly
Contribution 🤝
Contribution to this project is welcome! However, it must follow the code of conduct for the project.
Please file bug reports and feature requests in the issue tracker or submit pull requests to improve the source code or documentation.
For development guidance and standards, please see the development guide.
Additional Indicia
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file librovore-1.0a4.tar.gz.
File metadata
- Download URL: librovore-1.0a4.tar.gz
- Upload date:
- Size: 70.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fd996b8b8047c078e58824d011bbf8eb5881de357945f107d70f101f6383e4bf
|
|
| MD5 |
a5aa5c336a4168925f61c6ef182fc0ec
|
|
| BLAKE2b-256 |
84d1c37ccdb9bd40d1a734779a4f789c7ebe504492490d9f23b28467a9fb5ed4
|
Provenance
The following attestation bundles were made for librovore-1.0a4.tar.gz:
Publisher:
releaser.yaml on emcd/python-librovore
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
librovore-1.0a4.tar.gz -
Subject digest:
fd996b8b8047c078e58824d011bbf8eb5881de357945f107d70f101f6383e4bf - Sigstore transparency entry: 466873627
- Sigstore integration time:
-
Permalink:
emcd/python-librovore@5dda373195dda9906d8e554d3630bd6406f3641b -
Branch / Tag:
refs/tags/v1.0a4 - Owner: https://github.com/emcd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
releaser.yaml@5dda373195dda9906d8e554d3630bd6406f3641b -
Trigger Event:
push
-
Statement type:
File details
Details for the file librovore-1.0a4-py3-none-any.whl.
File metadata
- Download URL: librovore-1.0a4-py3-none-any.whl
- Upload date:
- Size: 117.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0194f305183ae2f76d5f07312c6032814675d93d2d01c9798784381ab481678d
|
|
| MD5 |
fb3f3acd9888452074e1379b23371117
|
|
| BLAKE2b-256 |
b3436c8d1fe9ab446b72d8c322e9b7e64e849f9f52099ba50f7f1976f668b0a4
|
Provenance
The following attestation bundles were made for librovore-1.0a4-py3-none-any.whl:
Publisher:
releaser.yaml on emcd/python-librovore
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
librovore-1.0a4-py3-none-any.whl -
Subject digest:
0194f305183ae2f76d5f07312c6032814675d93d2d01c9798784381ab481678d - Sigstore transparency entry: 466873636
- Sigstore integration time:
-
Permalink:
emcd/python-librovore@5dda373195dda9906d8e554d3630bd6406f3641b -
Branch / Tag:
refs/tags/v1.0a4 - Owner: https://github.com/emcd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
releaser.yaml@5dda373195dda9906d8e554d3630bd6406f3641b -
Trigger Event:
push
-
Statement type: