Bookworm
2025.03.27
4
Rust文档工具Rust 开发开发效率
Bookworm 是一个用于处理 [docs.rs](https://docs.rs) 文档的工具集合，主要用于下载、索引和查询 Rust 库的文档。它提供了一系列工具，帮助开发者更高效地访问和搜索 Rust 库的文档和源代码。
View on GitHub
Overview
基本能力
产品定位
Bookworm 是一个专门为 Rust 开发者设计的工具集合，旨在提供便捷的文档下载、索引和查询功能，帮助开发者更高效地访问和利用 Rust 库的文档资源。
核心功能
- 文档下载：从 docs.rs 下载 Rust 库的文档并存储到本地。
- 文档索引：将下载的文档索引到 SQLite 数据库中，便于快速查询。
- 文档查询：通过本地存储的文档和索引数据库，快速查询库的文档和源代码。
- MCP 服务：提供一个 MCP 服务器，用于服务库的文档信息。
适用场景
- 离线文档访问：开发者可以在没有网络连接的情况下访问 Rust 库的文档。
- 高效文档搜索：通过本地索引，快速搜索和定位文档中的特定内容。
- 开发工具集成：将文档查询功能集成到开发工具或 IDE 中，提升开发效率。
工具列表
- wrm_dl：下载 Rust 库的文档到本地。
- wrm_index：将本地文档索引到 SQLite 数据库。
- wrm_query：查询本地存储的文档和索引数据库。
- wrm_docs：从本地缓存的文档中获取详细信息。
- wrm_mcp：MCP 服务器，用于服务文档信息。
常见问题解答
- 如何下载文档？
sh cargo run --bin wrm-dl --features cli -- regex - 如何索引文档？
sh cargo run --bin wrm-index --features cli -- /tmp/... - 如何运行 MCP 服务器？
sh cargo run --bin wrm-mcp
使用教程
使用依赖
确保已安装 Rust 和 Cargo。
安装教程
- 克隆项目仓库。
- 使用 Cargo 构建项目：
sh cargo build
调试方式
- 运行 MCP 服务器：
sh cargo run --bin wrm-mcp - 在 MCP 客户端中添加服务器配置：
json { "mcpServers": { "bookworm": { "command": "/path/to/wrm-mcp" } } }