Bookworm

🚀 Bookworm

A set of tools for working with docs.rs documentation.

🚀 Quick Start

✨ Features

Bookworm offers a suite of tools designed to interact with and manage crate documentation from docs.rs. Here's an overview of each tool:

wrm_dl

Downloads the documentation of a crate from docs.rs and stores it in a local directory. It exists as both a library and a binary. You can run it locally as follows:

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

wrm_index

Indexes the locally stored crate documentation into an SQLite database. It exists as both a library and a binary. You can run it locally as follows:

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

wrm_query

Queries the documentation using the locally stored crate documentation and the indexed database.

wrm_docs

Retrieves detailed information from the cached docs.rs documentation.

wrm_mcp

A Model Context Protocol server for providing crate documentation. You can run it locally as follows:

cargo run --bin wrm-mcp

To add this server to an MCP-supporting client, follow the client's requirements. For example, for Claude.ai, you can use the following configuration:

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

Tools for LLMs with MCP Client Functionality

crates_search

Fetches a list of crates that match a given query. The returned list contains the URI of each crate for obtaining more crate information.

crate_search_items

Fetches a list of items that match a given query. Each item's type includes the following information:

• Item path (e.g., serde_json::value::Value)
• Item type (e.g., enum)
• Type signature
• Documentation
• Related resource URI

crate_search_src (TODO)

Searches all the source code of a crate to match a given query. Each item includes the following information:

• URI of the source code file
• Line number
• Content of the matching line, including context (if available)

crate_resource

Once a crate is found (or the crate name is known), you can use this tool to obtain the crate's resources. You can run it locally as follows:

cargo run --bin wrm-mcp

To add this server to an MCP-supporting client, follow the client's requirements. For example, for Claude.ai, you can use the following configuration:

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

URL Templates

• {crate_name} is the exact name of the crate.
• {crate_version} is a (partial) version number that conforms to semantic versioning, or latest to represent the latest released version of the crate.