Rust文档获取工具

一个用于从docs.rs获取Rust文档并转换为Markdown格式的CLI工具和MCP服务器。

  • by TheCactusBlue
  • Rust
  • 本地部署
  • 更新于
在 GitHub 查看 TheCactusBlue/rustdoc-mcp

使用说明

🦀 rustdoc-mcp(一个与Rust文档相关的项目或工具,具体名称可能根据上下文有所变化)🦀

一个用于从 docs.rs 获取 Rust 文档并以 Markdown 格式呈现的 CLI 工具和 MCP(模型上下文协议)服务器。

特点/功能

  • CLI 模式在您的终端中直接获取并显示 Rust 文档
  • MCP服务器模式通过模型上下文协议暴露Rust文档获取功能
  • 支持所有Rust项目类型:crate(库)、模块、结构体、枚举、特性(trait)、函数等
  • 带有语法高亮的Markdown格式输出

安装

cargo install --path .

用法

CLI 模式

获取特定crate或项目的文档:

# Fetch documentation for a crate
rustdoc-mcp fetch tokio

# Fetch documentation for a specific item with type
rustdoc-mcp fetch atrium_api::agent::Agent --item-type struct

# Fetch documentation for a module
rustdoc-mcp fetch std::collections --item-type module

MCP 服务器模式

作为MCP服务器运行,以实现与AI助手的集成:

rustdoc-mcp server

服务器暴露了一个 fetch_docs 接受以下输入的工具:

  • path货箱或物品路径(例如。, my_crate::submodule::MyStruct)
  • item_type项目的类型(例如。, struct, trait, module, enum)

配置

在您的Claude桌面配置中将其设置为MCP服务器:

{
  "mcpServers": {
    "rustdoc": {
      "command": "/path/to/rustdoc-mcp",
      "args": ["server"]
    }
  }
}

依赖项

  • rmcpMCP服务器实现
  • scraper & html2md/htmdHTML解析和Markdown转换
  • reqwest用于获取文档的HTTP客户端
  • clapCLI 参数解析
  • termimad终端Markdown渲染

许可证

详见LICENSE文件。