Rust Docs

🚀 MCP Rust 文檔服務器

這是一個模型上下文協議（MCP）服務器，主要用於獲取並返回Rust crate的文檔。當大語言模型（LLM）處理Rust代碼時，該服務器能為其提供必要的上下文信息，提升處理效率和準確性。

🚀 快速開始

本服務器可從docs.rs獲取Rust crate文檔，並進行處理後提供給LLM。通過簡單的安裝和配置，即可與AI助手集成使用。

✨ 主要特性

• 從docs.rs上可用的任何Rust crate獲取文檔。
• 刪除HTML並格式化內容以便於閱讀。
• 限制響應大小以防淹沒客戶端。
• 使用最新版本的MCP SDK（v1.6.1）。

📦 安裝指南

必備條件

• Node.js
• npm

# 克隆倉庫
git https://github.com/0xKoda/mcp-rust-docs.git
cd mcp-rust-docs

# 安裝依賴項
npm install

💻 使用示例

基礎用法

# 直接啟動服務器
npm start

高級用法

與AI助手集成 - Claude Desktop

在Claude Desktop配置文件（claude_desktop_config.json）中添加以下內容：

{
  "mcpServers": {
    "rust-docs": {
      "command": "node",
      "args": ["/absolute/path/to/index.js"]
    }
  }
}

將/absolute/path/to/index.js替換為該倉庫中index.js文件的絕對路徑。

示例用法

一旦服務器運行並配置好您的AI助手，您可以提出如下問題：

• “查找‘tokio’crate的文檔”
• “‘serde’ crate提供了哪些功能？”
• “顯示‘ratatui’的文檔”
• “你能解釋‘axum’ crate的主要模塊嗎？” AI將使用lookup_crate_docs工具獲取並顯示相關文檔。

使用MCP Inspector測試

您可以通過運行以下命令來測試此服務器：

npx @modelcontextprotocol/inspector

然後選擇“連接到本地服務器”選項並根據提示操作。

📚 詳細文檔

工作原理

此服務器實現了名為lookup_crate_docs的單個MCP工具，其執行步驟如下：

1. 接收Rust crate名稱作為輸入（可選，默認為‘tokio’如果未提供）。
2. 從docs.rs獲取文檔。
3. 使用html-to-text庫將HTML轉換為純文本。
4. 如果內容超過8000字符則截斷。
5. 以正確的MCP響應格式返回格式化後的文檔。

SDK實現注意事項

此服務器使用了經過精心結構調整的導入路徑的MCP SDK。如果您正在修改代碼，請注意：

1. SDK需要從特定路徑進行導入（例如@modelcontextprotocol/sdk/server/mcp.js）。
2. 我們使用高階McpServer API而不是低階工具。
3. 工具定義使用Zod進行參數驗證。
4. 將控制檯輸出重定向到stderr以免破壞MCP協議。
5. 工具返回正確的MCP響應對象。

📄 許可證

MIT