Cratedocs MCP

🚀 CrateDocs MCP サーバー

このサーバーは、Model Context Protocol (MCP) に準拠しており、Rust crate のドキュメント検索用のツールを提供します。大型言語モデル（LLM）が不慣れな crate のドキュメントを検索できるようになります。

✨ 主な機能

• crate ドキュメントの検索：特定の Rust crate の一般的なドキュメントを取得します。
• crate の検索：キーワードに基づいて crates.io 上で crate を検索します。
• 項目ドキュメントの検索：crate 内の特定の項目（例：構造体、関数、トレイト）のドキュメントを取得します。

📦 インストール

git clone https://github.com/d6e/cratedocs-mcp.git
cd cratedocs-mcp
cargo build --release

🚀 クイックスタート

サーバーの起動方法

ドキュメントサーバーを起動する方法はいくつかあります。

統一 CLI を使用する場合

統一コマンドラインインターフェイスは、すべてのサーバーモードのサブコマンドを提供します。

# STDIN/STDOUT モードで起動
cargo run --bin cratedocs stdio

# HTTP/SSE モードで起動（デフォルトアドレス：127.0.0.1:8080）
cargo run --bin cratedocs http

# カスタムアドレスで HTTP/SSE モードを起動
cargo run --bin cratedocs http --address 0.0.0.0:3000

# デバッグログを有効にする
cargo run --bin cratedocs http --debug

ドキュメントツールを直接テストする場合

サーバーを起動せずに、コマンドラインから直接ドキュメントツールをテストできます。

# help コマンドのヘルプを取得
cargo run --bin cratedocs test --tool help

# crate ドキュメントを検索
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio

# 特定の項目のドキュメントを検索
cargo run --bin cratedocs test --tool lookup_item --crate-name tokio --item-path sync::mpsc::Sender

# 特定のバージョンのドキュメントを検索
cargo run --bin cratedocs test --tool lookup_item --crate-name serde --item-path Serialize --version 1.0.147

# crate を検索
cargo run --bin cratedocs test --tool search_crates --query logger --limit 5

# 異なる形式で出力（Markdown、プレーンテキスト、JSON）
cargo run --bin cratedocs test --tool search_crates --query logger --format markdown
cargo run --bin cratedocs test --tool search_crates --query logger --format plain
cargo run --bin cratedocs test --tool search_crates --query logger --format json

# 出力をファイルにリダイレクト
cargo run --bin cratedocs test --tool search_crates --query logger --format markdown > output.md

💻 使用例

基本的な使用法

各ツールの基本的な使用方法を以下に示します。

lookup_crate

特定の crate のドキュメントを検索します。

パラメータ

• --crate-name：検索する crate の名前を指定します（必須）。
• --version：crate のバージョンを指定します（オプション、デフォルトは最新バージョン）。

サンプル JSON 出力

{
  "name": "tokio",
  "version": "1.0.0",
  "documentation_url": "https://docs.rs/tokio/latest/tokio/",
  "description": "A runtime for async tasks built on the Rust programming language."
}

search_crates

crates.io 上で crate を検索します。

パラメータ

• --query：検索キーワードを指定します（必須）。
• --limit：返す結果の数を指定します（オプション、デフォルトは 10）。
• --format：出力形式を指定します（オプション、markdown、plain、または json をサポート）。

サンプル JSON 出力

[
  {
    "name": "tokio",
    "version": "1.0.0",
    "documentation_url": "https://docs.rs/tokio/latest/tokio/",
    "description": "A runtime for async tasks built on the Rust programming language."
  },
  {
    "name": "serde",
    "version": "1.0.0",
    "documentation_url": "https://docs.rs/serde/latest/serde/",
    "description": "A library for serializing and deserializing data represented as Rust structs."
  }
]

lookup_item

crate 内の特定の項目のドキュメントを検索します。

パラメータ

• --crate-name：crate の名前を指定します（必須）。
• --item-path：検索する項目のパスを指定します（例：sync::mpsc::Sender）（必須）。
• --version：crate のバージョンを指定します（オプション、デフォルトは最新バージョン）。

サンプル JSON 出力

{
  "name": "tokio",
  "version": "1.0.0",
  "item_path": "sync::mpsc::Sender",
  "documentation_url": "https://docs.rs/tokio/latest/tokio/sync/mpsc/Sender/",
  "description": "A message channel type that allows sending messages between tasks."
}

🔧 技術詳細

• キャッシュ機構：サーバーはキャッシュを使用してパフォーマンスを向上させ、同じデータの重複検索を避けます。
• インターフェース：サーバーは docs.rs や crates.io などの API インターフェースと統合されており、crate のドキュメントと情報を取得します。
• 結果形式：出力結果は JSON 形式で、Markdown、プレーンテキスト、JSON の複数の形式をサポートしています。

📚 ドキュメント

MCP プロトコルの統合

CrateDocs サーバーは、Model Context Protocol (MCP) に準拠しており、MCP をサポートする大型言語モデル（LLM）クライアントとの統合を可能にします。この統合により、LLM は Rust crate のドキュメントにより効率的にアクセスし、理解することができ、より良いコード生成と問題解決能力を提供します。