Docs.rs

🚀 貨運文檔 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 許可證。