Bookworm

🚀 書蟲

書蟲是一組用於與 docs.rs 文檔協同工作的工具，能夠幫助用戶下載、索引和查詢 crate 文檔，還能通過 MCP 服務器為具有 MCP 客戶端功能的 LLM 提供相關服務。

✨ 主要特性

• 支持從 docs.rs 下載 crate 文檔並本地存儲。
• 可將本地存儲的 crate 文檔索引到 SQLite 數據庫。
• 能夠利用本地文檔和索引數據庫進行文檔查詢。
• 提供 MCP 服務器，方便支持 MCP 客戶端的 LLM 使用相關工具。

📦 安裝指南

由於文檔未提供具體安裝步驟，暫無法展示。

💻 使用示例

基礎用法

wrm_dl

從 docs.rs 下載 crate 的文檔並將其存儲在本地目錄中。它既作為庫又作為二進制文件存在，您可以通過以下方式在本地運行：

cargo run --bin wrm-dl --features cli -- regex
Documentation 成功下載到 /tmp/...

wrm_index

將本地存儲的 crate 文檔索引到 SQLite 數據庫中。它既作為庫又作為二進制文件存在，您可以通過以下方式在本地運行：

cargo run --bin wrm-index --features cli -- /tmp/...
文檔成功索引到 ./index.sqlite

wrm_mcp

一個 模型上下文協議 服務器，用於提供 crate 的文檔。通過以下方式在本地運行：

cargo run --bin wrm-mcp

要將此服務器添加到支持 MCP 客戶端，請根據客戶端要求操作。例如，對於 Claude.ai，可以使用以下配置：

{
  "mcpServers": {
    "bookworm": {
      "command": "/path/to/wrm-mcp"
    }
  }
}

高級用法

wrm_query

使用本地存儲的 crate 文檔和索引數據庫查詢文檔。

wrm_docs

從緩存的 docs.rs 文檔中獲取詳細信息。

工具

具有 MCP 客戶端功能的 LLM 可以使用以下工具：

crates_search

獲取與給定查詢匹配的 crate 列表。返回的列表包含每個 crate 的 URI，用於獲取更多 crate 信息。

crate_search_items

獲取與給定查詢匹配的項目列表。每個項目的類型包含以下信息：

• 項目路徑（例如 serde_json::value::Value）
• 項目類型（例如 枚舉）
• 類型簽名
• 文檔
• 相關資源 URI

crate_search_src (TODO)

搜索 crate 的所有源代碼，以給定的查詢匹配。每個項目包含以下信息：

• 源代碼文件的 URI
• 行號
• 匹配行的內容，包括上下文（如果有）

crate_resource

一旦找到一個 crate（或已知 crate 名稱），您可以通過此工具獲取該 crate 的資源。通過以下方式在本地運行：

cargo run --bin wrm-mcp

要將此服務器添加到支持 MCP 客戶端，請根據客戶端要求操作。例如，對於 Claude.ai，可以使用以下配置：

{
  "mcpServers": {
    "bookworm": {
      "command": "/path/to/wrm-mcp"
    }
  }
}

URL 模板

• {crate_name} 是 crate 的確切名稱。
• {crate_version} 是符合語義化版本控制的（部分）版本號，或 latest 表示最新發布的 crate 版本。