Overview
what is Bookworm?
Bookworm is a collection of tools designed to work with Rust documentation available on docs.rs, providing functionalities to download, index, and query crate documentation.
how to use Bookworm?
To use Bookworm, you can run various commands using Cargo, such as downloading documentation, indexing it into a SQLite database, or querying the documentation through a model context protocol (MCP) server.
key features of Bookworm?
- Download documentation for Rust crates from docs.rs.
- Index downloaded documentation into a local SQLite database.
- Query documentation using a locally stored version and an index database.
- Serve documentation through an MCP server for integration with LLM clients.
use cases of Bookworm?
- Downloading and storing Rust crate documentation for offline access.
- Indexing documentation for fast local queries.
- Integrating with LLMs to provide documentation support in AI applications.
FAQ from Bookworm?
- Can Bookworm work with any Rust crate?
Yes! Bookworm can download and index documentation for any crate available on docs.rs.
- Is there a graphical interface for Bookworm?
No, Bookworm is command-line based and does not have a graphical user interface.
- What is the MCP server used for?
The MCP server allows integration with clients that support the model context protocol, enabling them to access Rust documentation dynamically.