CrateDocs MCP

CrateDocs MCP

site icon
2025.04.10 19
RustRust 文档查询开发工具开发效率
CrateDocs MCP 是一个基于 Model Context Protocol (MCP) 的服务,专门用于 Rust crate 文档的查询。它允许 LLMs(大型语言模型)查找不熟悉的 Rust crate 的文档。该服务提供了查找 crate 文档、搜索 crate 以及查找 crate 中特定项目(如结构体、函数、特性等)文档的功能。
View on GitHub

Overview

基本能力

产品定位

CrateDocs MCP 是一个 Rust crate 文档查询服务,旨在为开发者和 LLMs 提供便捷的 Rust crate 文档查找功能。

核心功能

  1. 查找 crate 文档:获取 Rust crate 的通用文档。
  2. 搜索 crate:基于关键词在 crates.io 上搜索 crate。
  3. 查找项目文档:获取 crate 中特定项目(如结构体、函数、特性等)的文档。

适用场景

  1. 开发者在编写 Rust 代码时需要快速查阅 crate 文档。
  2. LLMs 在生成代码时需要参考 Rust crate 的文档。
  3. 团队协作中需要共享和查阅 Rust crate 的文档。

工具列表

  1. lookup_crate:检索指定 Rust crate 的文档。
  2. 参数:crate_name(必需),version(可选)。
  3. search_crates:在 crates.io 上搜索 Rust crate。
  4. 参数:query(必需),limit(可选)。
  5. lookup_item:检索 crate 中特定项目的文档。
  6. 参数:crate_name(必需),item_path(必需),version(可选)。

常见问题解答

  1. 如何启用调试日志?
  2. 使用 --debug 参数运行 HTTP 服务器。
  3. 如何自定义服务器地址?
  4. 使用 --address 参数指定自定义地址。
  5. 如何保存输出到文件?
  6. 使用 --output 参数指定输出文件路径。

使用教程

使用依赖

  1. 确保已安装 Rust 和 Cargo。
  2. 克隆仓库: bash git clone https://github.com/d6e/cratedocs-mcp.git cd cratedocs-mcp

安装教程

  1. 构建项目: bash cargo build --release

调试方式

  1. STDIN/STDOUT 模式bash cargo run --bin cratedocs stdio
  2. HTTP/SSE 模式(默认地址:127.0.0.1:8080): bash cargo run --bin cratedocs http
  3. 自定义地址bash cargo run --bin cratedocs http --address 0.0.0.0:3000
  4. 启用调试日志bash cargo run --bin cratedocs http --debug

直接测试文档工具

  1. 查找 crate 文档bash cargo run --bin cratedocs test --tool lookup_crate --crate-name tokio
  2. 查找项目文档bash cargo run --bin cratedocs test --tool lookup_item --crate-name tokio --item-path sync::mpsc::Sender
  3. 搜索 cratebash cargo run --bin cratedocs test --tool search_crates --query logger --limit 5

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。