Rust文档管理服务器

一个通过cargo doc命令管理Rust文档的MCP服务器,提供检查、构建和搜索Rust文档的工具。

  • by spacemeowx2
  • TypeScript
  • 本地部署
  • 10 星标
  • 更新于
在 GitHub 查看 spacemeowx2/cargo-doc-mcp

使用说明

货物单据MCP服务器

一个MCP服务器,用于通过cargo-doc命令管理Rust文档。此服务器提供在本地检查、构建和搜索Rust文档的工具。

特性

工具

  • get_crate_doc -获取crate的主文档页面,以了解总体概念和用法

    • 参数:
      • project_path:Rust项目的路径(必须是绝对路径)
      • crate_name:要获取文档的板条箱名称
  • list_symbols -列出机箱文档中的所有符号(结构、枚举、特征等)

    • 参数:
      • project_path:Rust项目的路径(必须是绝对路径)
      • crate_name:列出符号的板条箱名称
  • search_doc -在板条箱的文档中搜索

    • 参数:
      • project_path:Rust项目的路径(必须是绝对路径)
      • crate_name:要搜索的板条箱的名称
      • query:搜索查询(关键字或符号)
      • limit (可选):返回的最大结果数(默认值:10)

需求

  • Node.js 16或更高版本
  • 铁锈和货物已安装

安装

安装依赖项:

pnpm install

构建服务器:

pnpm run build

对于自动重建的开发:

pnpm run watch

用法

添加以下配置:

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

调试

由于MCP服务器通过stdio进行通信,调试可能具有挑战性。我们建议使用MCP检查器:

pnpm run inspector

检查器将提供一个URL,用于访问浏览器中的调试工具。

缓存系统

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

许可证

麻省理工学院