基本能力
产品定位
CrateDocs MCP 是一个 Rust crate 文档查询服务，旨在为开发者和 LLMs 提供便捷的 Rust crate 文档查找功能。
核心功能
- 查找 crate 文档：获取 Rust crate 的通用文档。
- 搜索 crate：基于关键词在 crates.io 上搜索 crate。
- 查找项目文档：获取 crate 中特定项目（如结构体、函数、特性等）的文档。
适用场景
- 开发者在编写 Rust 代码时需要快速查阅 crate 文档。
- LLMs 在生成代码时需要参考 Rust crate 的文档。
- 团队协作中需要共享和查阅 Rust crate 的文档。
工具列表
lookup_crate：检索指定 Rust crate 的文档。- 参数：
crate_name（必需），version（可选）。 search_crates：在 crates.io 上搜索 Rust crate。- 参数：
query（必需），limit（可选）。 lookup_item：检索 crate 中特定项目的文档。- 参数：
crate_name（必需），item_path（必需），version（可选）。
常见问题解答
- 如何启用调试日志？
- 使用
--debug参数运行 HTTP 服务器。 - 如何自定义服务器地址？
- 使用
--address参数指定自定义地址。 - 如何保存输出到文件？
- 使用
--output参数指定输出文件路径。
使用教程
使用依赖
- 确保已安装 Rust 和 Cargo。
- 克隆仓库：
bash
git clone https://github.com/d6e/cratedocs-mcp.git
cd cratedocs-mcp
安装教程
- 构建项目：
bash
cargo build --release
调试方式
- STDIN/STDOUT 模式：
bash
cargo run --bin cratedocs stdio - HTTP/SSE 模式（默认地址：127.0.0.1:8080）：
bash
cargo run --bin cratedocs http - 自定义地址：
bash
cargo run --bin cratedocs http --address 0.0.0.0:3000 - 启用调试日志：
bash
cargo run --bin cratedocs http --debug
直接测试文档工具
- 查找 crate 文档：
bash
cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio - 查找项目文档：
bash
cargo run --bin cratedocs test --tool lookup_item --crate-name tokio --item-path sync::mpsc::Sender - 搜索 crate：
bash
cargo run --bin cratedocs test --tool search_crates --query logger --limit 5
