Bookworm

一个用于处理 docs.rs 文档的工具集合。

Crates

wrm_dl

从 docs.rs 下载 crate 的文档，并将其存储在本地目录中。

它既可以作为库使用，也可以作为二进制文件使用。您可以使用以下命令在本地运行它：

cargo run --bin wrm-dl --features cli -- regex
Documentation downloaded successfully to /tmp/...

wrm_index

将本地存储的 crate 文档索引到 SQLite 数据库中。

它既可以作为库使用，也可以作为二进制文件使用。您可以使用以下命令在本地运行它：

cargo run --bin wrm-index --features cli -- /tmp/...
Documentation indexed successfully to ./index.sqlite

wrm_query

使用本地存储的 crate 文档和索引数据库，查询 crate 的文档。

wrm_docs

从本地缓存的 docs.rs 文档中获取详细信息。

wrm_mcp

一个 模型上下文协议 服务器，用于提供 crate 的文档。

使用以下命令在本地运行它：

cargo run --bin wrm-mcp

将服务器添加到您的 MCP 客户端取决于客户端，但以下示例适用于 Claude.ai：

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

工具

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

crates_search

获取与给定查询匹配的 crate 列表。

返回的列表包含每个 crate 的 URI 列表，用于获取其他 crate 信息。

crate_search_items

获取与给定查询匹配的条目列表。

每个条目类型包含以下信息：

• 条目路径 (例如 serde_json::value::Value)
• 条目类型 (例如 enum)
• 类型签名
• 文档
• 相关资源 URI

crate_search_src (TODO)

在 crate 的所有源代码中搜索给定的查询。

每个条目包含源代码文件的 URI、行号以及匹配行的内容，包括任何可选的上下文。

crate_resource

一旦您找到一个 crate（或知道 crate 名称），您可以通过 crate_resource 工具获取相关资源。 此工具接受资源的 URI。

支持以下 URI：

• crate://{crate_name} - 列出 crate 版本
• crate://{crate_name}/{crate_version} - 获取元数据
• crate://{crate_name}/{crate_version}/readme - 获取 readme 内容
• crate://{crate_name}/{crate_version}/items - 列出条目资源
• crate://{crate_name}/{crate_version}/src - 列出源代码资源
• crate://{crate_name}/{crate_version}/{path} - 获取条目/src 资源

crate://{crate_name} - 列出 crate 版本

返回给定 crate 名称的 crate 版本列表。

列表中的每个条目包含以下信息：

• 版本
• 发布日期
• MSRV
• 下载量
• 发布者

crate://{crate_name}/{crate_version} - 获取 crate 元数据

返回以下元数据：

• 名称
• 版本
• 发布日期
• 描述
• 主页
• 仓库
• 许可证
• URI：
  • Readme (例如 crate://serde_json/1.0.85/readme)
  • Crate 条目 (例如 crate://serde_json/1.0.85/items)
  • 源代码 (例如 crate://serde_json/1.0.85/src)

crate://{crate_name}/{crate_version}/readme - 获取 crate readme

以 Markdown 格式返回 crate README 作为字符串。

crate://{crate_name}/{crate_version}/items - 列出 crate 条目

返回给定 crate 版本的条目列表。

条目是 crate 的一个组成部分。 有几种类型的条目：

• 模块
• 函数定义
• 类型定义
• 结构体定义
• 枚举定义
• 特征定义
• 实现

使用 search_crate_items 搜索特定条目。

crate://{crate_name}/{crate_version}/src - 列出 crate 源代码资源

返回给定 crate 版本的源代码资源列表。

例如：

<Resources>
  <Resource uri="crate://serde_json/1.0.85/src/serde_json/lib.rs" />
  <Resource uri="crate://serde_json/1.0.85/src/serde_json/value.rs" />
  <Resource uri="crate://serde_json/1.0.85/src/serde_json/map.rs" />
  <Resource uri="crate://serde_json/1.0.85/src/serde_json/value/mod.rs" />
  ...
</Resources>

使用 search_crate_src 搜索 crate 的所有源代码。

crate://{crate_name}/{crate_version}/{crate_resource_path} - 获取 crate 资源

返回给定路径下资源的内容。

URL 模板

• {crate_name} 是 crate 的确切名称。
• {crate_version} 是一个（部分）semver 兼容的版本号，或者 latest 表示最新的已发布 crate 版本。