cargo doc MCP Server
2025.03.19
5
TypeScriptRust 文档管理本地文档查看文档搜索开发效率
cargo-doc-mcp 是一个用于管理 Rust 文档的 MCP 服务器，通过 cargo doc 命令提供检查、构建和搜索 Rust 本地文档的工具。
View on GitHub
Overview
基本能力
产品定位
cargo-doc-mcp 是一个专门为 Rust 开发者设计的文档管理工具，旨在提供便捷的本地文档查看和搜索功能。
核心功能
- 获取文档页面：通过
get_crate_doc工具获取指定 crate 的主文档页面，帮助开发者理解整体概念和使用方法。 - 列出符号：使用
list_symbols工具列出 crate 文档中的所有符号（如结构体、枚举、特质等）。 - 文档搜索：通过
search_doc工具在 crate 文档中进行关键词或符号搜索。
适用场景
- Rust 开发者需要快速查看本地文档时。
- 在开发过程中需要查找特定符号或关键词的文档时。
- 需要管理多个 Rust 项目的文档时。
工具列表
- get_crate_doc：获取 crate 的主文档页面。
- 参数：
project_path（Rust 项目的绝对路径）、crate_name（crate 名称）。 - list_symbols：列出 crate 文档中的所有符号。
- 参数：
project_path（Rust 项目的绝对路径）、crate_name（crate 名称）。 - search_doc：在 crate 文档中搜索。
- 参数：
project_path（Rust 项目的绝对路径）、crate_name（crate 名称）、query（搜索查询）、limit（可选，返回结果的最大数量，默认 10）。
常见问题解答
- 缓存系统：服务器维护一个构建文档路径的缓存以提高性能，缓存条目在 24 小时后过期以确保文档保持最新。
- 调试：由于 MCP 服务器通过 stdio 通信，调试可能具有挑战性，建议使用 MCP Inspector 进行调试。
使用教程
使用依赖
- Node.js 16 或更高版本
- Rust 和 Cargo 已安装
安装教程
- 安装依赖：
bash pnpm install - 构建服务器：
bash pnpm run build - 开发时自动重建：
bash pnpm run watch
调试方式
使用 MCP Inspector 进行调试：
pnpm run inspector
Inspector 将提供一个 URL，用于在浏览器中访问调试工具。