Cratedocs MCP

🚀 CrateDocs MCP 服務器

CrateDocs MCP 服務器遵循 Model Context Protocol (MCP)，是一款專為 Rust crate 文檔查找打造的工具。它能助力大型語言模型（LLM）查找其不熟悉的 crate 文檔，極大提升工作效率。

🚀 快速開始

CrateDocs MCP 服務器是遵循 Model Context Protocol (MCP) 的工具，可用於 Rust crate 文檔查找，讓大型語言模型能查找不熟悉的 crate 文檔。

✨ 主要特性

• 查找 crate 文檔：可獲取特定 Rust crate 的通用文檔。
• 搜索 crate：能根據關鍵詞在 crates.io 上搜索 crate。
• 查找項文檔：可獲取 crate 中特定項（如結構體、函數、特徵）的文檔。

📦 安裝指南

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

💻 使用示例

基礎用法

運行服務器

有多種方式運行文檔服務器：

# 以 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 的文檔。

{
  "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。

[
  {
    "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 中特定項的文檔。

{
  "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 多種格式。

📚 詳細文檔

CrateDocs 服務器遵循 Model Context Protocol (MCP)，允許它與支持 MCP 的大型語言模型（LLM）客戶端集成。這種集成使得 LLM 能夠更高效地訪問和理解 Rust crate 文檔，從而提供更好的代碼生成和問題解決能力。