Bookworm

🚀 書虫

書虫は、docs.rs のドキュメントを操作するための一連のツールです。これらのツールを使用することで、docs.rs からのドキュメントのダウンロード、ローカルでの索引付け、クエリなどの操作が可能になります。

🚀 クイックスタート

このセクションでは、書虫が提供する各ツールの概要と使用方法を説明します。

✨ 主な機能

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_query

ローカルに保存された 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_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} はセマンティックバージョニングに準拠した（一部の）バージョン番号、または最新の crate バージョンを表す latest です。