🚀 货运文档 MCP 服务器

这是一个借助 cargo doc 命令来管理 Rust 文档的 MCP 服务器。它提供了检查、构建和搜索本地 Rust 文档的工具，能有效提升 Rust 文档管理的效率。

🚀 快速开始

此服务器可通过 cargo doc 命令管理 Rust 文档，使用前需确保满足相关需求并完成安装。

✨ 主要特性

工具

• get_crate_doc - 获取 crate 的主文档页面，用于理解整体概念和用法
  • 参数:
    • project_path: 项目路径（必须为绝对路径）
    • crate_name: 要获取文档的 crate 名称
• list_symbols - 列出 crate 文档中的所有符号（结构体、枚举、特征等）
  • 参数:
    • project_path: 项目路径（必须为绝对路径）
    • crate_name: 要列出符号的 crate 名称
• search_doc - 在 crate 的文档中搜索内容
  • 参数:
    • project_path: 项目路径（必须为绝对路径）
    • crate_name: 要在其中搜索的 crate 名称
    • query: 搜索查询（关键词或符号）
    • limit（可选）: 返回结果的最大数量（默认：10）

📦 安装指南

需求

• Node.js 16 或更高版本
• 安装了 Rust 和 Cargo

安装步骤

1. 安装依赖：

pnpm install

2. 构建服务器：

pnpm run build

3. 开发模式（自动重建）：

pnpm run watch

💻 使用示例

基础用法

添加以下配置：

{
  "mcpServers": {
    "docs-rs-mcp": {
      "command": "/absolute/path/to/docs-rs-mcp/build/index.js"
    }
  }
}

📚 详细文档

调试

由于 MCP 服务器通过标准输入输出进行通信，调试可能具有挑战性。我们推荐使用 MCP Inspector：

pnpm run inspector

Inspector 会提供一个在浏览器中访问调试工具的 URL。

缓存系统

该服务器维护了一个构建文档路径的缓存以提高性能。缓存条目在 24 小时后过期，以确保文档保持最新。

📄 许可证

本项目采用 MIT 许可证。