MCP 服务器

Rust Docs MCP Server

🦀 防止 AI 助手提供过时的 Rust 代码建议。这个 MCP 服务器获取最新的 crate 文档，使用嵌入/LLM，并通过工具调用提供准确的上下文。

Govcraft

开发者工具

访问服务器

README

Rust Docs MCP 服务器

⭐ 喜欢这个项目吗？请在 GitHub 上给仓库点个 Star 以示支持并保持更新！ ⭐

动机

现代 AI 驱动的编码助手（如 Cursor、Cline、Roo Code 等）擅长理解代码结构和语法，但通常难以掌握快速发展的库和框架的具体细节，尤其是在像 Rust 这样的生态系统中，crate 会频繁更新。它们的训练数据截止日期意味着它们可能缺乏对最新 API 的了解，从而导致不正确或过时的代码建议。

这个 MCP 服务器通过为特定的 Rust crate 提供一个集中的、最新的知识来源来解决这个问题。通过为 crate（例如 serde、tokio、reqwest）运行此服务器的实例，您可以为您的 LLM 编码助手提供一个工具 (query_rust_docs)，它可以在编写与该 crate 相关的代码_之前_使用。

当指示使用此工具时，LLM 可以提出关于 crate 的 API 或用法的具体问题，并接收直接从_当前_文档中获得的答案。这显著提高了生成代码的准确性和相关性，减少了手动更正的需要，并加快了开发速度。

可以并发运行此服务器的多个实例，允许 LLM 助手在编码会话期间访问多个不同 crate 的文档。

此服务器获取指定 Rust crate 的文档，为内容生成嵌入，并提供一个 MCP 工具来根据文档上下文回答有关 crate 的问题。

特性

目标文档： 每个服务器实例专注于单个 Rust crate。
特性支持： 允许指定生成文档所需的 crate 特性。
语义搜索： 使用 OpenAI 的 text-embedding-3-small 模型来查找给定问题的最相关的文档部分。
LLM 摘要： 利用 OpenAI 的 gpt-4o-mini-2024-07-18 模型，_仅_基于检索到的文档上下文生成简洁的答案。
缓存： 基于 crate、版本和请求的特性，将生成的文档内容和嵌入缓存在用户的 XDG 数据目录（~/.local/share/rustdocs-mcp-server/ 或类似位置）中，以加快后续启动速度。
MCP 集成： 作为标准 MCP 服务器通过 stdio 运行，公开工具和资源。

前提条件

OpenAI API 密钥： 生成嵌入和总结答案需要此密钥。服务器期望此密钥在 OPENAI_API_KEY 环境变量中可用。（服务器还需要网络访问权限才能下载 crate 依赖项并与 OpenAI API 交互）。

安装

推荐的安装方式是从 GitHub Releases 页面下载适用于您操作系统的预编译二进制文件。

转到 Releases 页面。
下载适用于您系统的适当存档（Windows 为 .zip，Linux/macOS 为 .tar.gz）。
解压 rustdocs_mcp_server（或 rustdocs_mcp_server.exe）二进制文件。
将二进制文件放置在系统 PATH 环境变量中包含的目录中（例如，/usr/local/bin、~/bin）。

从源代码构建（替代方法）

如果您更喜欢从源代码构建，则需要安装 Rust 工具链。

克隆仓库：

git clone https://github.com/Govcraft/rust-docs-mcp-server.git
cd rust-docs-mcp-server

构建服务器：
```
cargo build --release
```

用法

新 Crates 的重要提示：

首次将服务器与 crate 一起使用（或使用新的版本/特性集）时，它需要下载文档并生成嵌入。此过程可能需要一些时间，特别是对于具有大量文档的 crate，并且需要有效的互联网连接和 OpenAI API 密钥。

建议在将任何新的 crate 配置添加到您的 AI 编码助手（如 Roo Code、Cursor 等）之前，先从命令行直接运行一次服务器。这允许完成初始嵌入生成和缓存。一旦您看到服务器启动消息指示它已准备好（例如，“MCP Server listening on stdio”），您可以关闭它（Ctrl+C）。后续启动，包括由您的编码助手启动的启动，将使用缓存的数据并启动得更快。

运行服务器

服务器从命令行启动，并且需要目标 crate 的 Package ID Specification。此规范遵循 Cargo 使用的格式（例如，crate_name、crate_name@version_req）。有关完整的规范详细信息，请参阅 man cargo-pkgid 或 Cargo 文档。

可选地，您可以使用 -F 或 --features 标志指定所需的 crate 特性，后跟一个逗号分隔的特性列表。对于需要启用特定特性才能使 cargo doc 成功的 crate 来说，这是必要的（例如，需要运行时特性的 crate，如 async-stripe）。

# 设置 API 密钥（替换为您实际的密钥）
export OPENAI_API_KEY="sk-..."

# 示例：为 serde 的最新 1.x 版本运行服务器
rustdocs_mcp_server "serde@^1.0"

# 示例：为 reqwest 的特定版本运行服务器
rustdocs_mcp_server "reqwest@0.12.0"

# 示例：为 tokio 的最新版本运行服务器
rustdocs_mcp_server tokio

# 示例：为 async-stripe 运行服务器，启用所需的运行时特性
rustdocs_mcp_server "async-stripe@0.40" -F runtime-tokio-hyper-rustls

# 示例：为另一个具有多个特性的 crate 运行服务器
rustdocs_mcp_server "some-crate@1.2" --features feat1,feat2

对于特定 crate 版本_和特性集_的首次运行，服务器将：

使用 cargo doc（使用指定的特性）下载 crate 文档。
解析 HTML 文档。
使用 OpenAI API 为文档内容生成嵌入（这可能需要一些时间并产生费用，但对于大多数 crate 来说，通常只有几美分；即使像 async-stripe 这样的大型 crate，拥有超过 5000 个文档页面，在测试期间生成嵌入的成本也只有 0.18 美元）。
缓存文档内容和嵌入，以便不再产生费用。
启动 MCP 服务器。

后续对同一 crate 版本_和特性集_的运行将从缓存加载数据，从而使启动速度更快。

MCP 交互

服务器使用 Model Context Protocol 通过标准输入/输出 (stdio) 进行通信。它公开以下内容：

工具：query_rust_docs

描述： 使用语义搜索和 LLM 摘要查询服务器启动时针对的特定 Rust crate 的文档。

输入模式：

{
  "type": "object",
  "properties": {
    "question": {
      "type": "string",
      "description": "关于 crate 的 API 或用法的具体问题。"
    }
  },
  "required": ["question"]
}

输出： 包含 LLM 基于相关文档上下文生成的答案的文本响应，前缀为 From <crate_name> docs:。

示例 MCP 调用：

{
  "jsonrpc": "2.0",
  "method": "callTool",
  "params": {
    "tool_name": "query_rust_docs",
    "arguments": {
      "question": "如何使用 reqwest 发出简单的 GET 请求？"
    }
  },
  "id": 1
}

资源：crate://<crate_name>
- 描述： 提供此服务器实例配置的 Rust crate 的名称。
- URI： crate://<crate_name>（例如，crate://serde、crate://reqwest）
- 内容： 包含 crate 名称的纯文本。
日志记录： 服务器通过 logging/message 通知将信息日志（启动消息、查询处理步骤）发送回 MCP 客户端。

示例客户端配置 (Roo Code)

您可以配置像 Roo Code 这样的 MCP 客户端来运行此服务器的多个实例，每个实例针对不同的 crate。以下是 Roo Code 的 mcp_settings.json 文件的示例片段，配置了 reqwest 和 async-stripe 的服务器（请注意为 async-stripe 添加的特性参数）：

{
  "mcpServers": {
    "rust-docs-reqwest": {
      "command": "/path/to/your/rustdocs_mcp_server",
      "args": [
        "reqwest@0.12"
      ],
      "env": {
        "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY_HERE"
      },
      "disabled": false,
      "alwaysAllow": []
    },
    "rust-docs-async-stripe": {
      "command": "rustdocs_mcp_server",
      "args": [
        "async-stripe@0.40",
        "-F",
        " runtime-tokio-hyper-rustls"
      ],
      "env": {
        "OPENAI_API_KEY": "YOUR_OPENAI_API_KEY_HERE"
      },
      "disabled": false,
      "alwaysAllow": []
    }
  }
}

注意：

如果 /path/to/your/rustdocs_mcp_server 不在您的 PATH 中，请将其替换为系统上已编译二进制文件的实际路径。
将 YOUR_OPENAI_API_KEY_HERE 替换为您实际的 OpenAI API 密钥。
键（rust-docs-reqwest、rust-docs-async-stripe）是您选择的任意名称，用于标识 Roo Code 中的服务器实例。

示例客户端配置 (Claude Desktop)

对于 Claude Desktop 用户，您可以在 MCP 设置中配置服务器。以下是配置 serde 和 async-stripe 服务器的示例：

{
  "mcpServers": {
    "rust-docs-serde": {
      "command": "/path/to/your/rustdocs_mcp_server",
      "args": [
        "serde@^1.0"
      ]
    },
    "rust-docs-async-stripe-rt": {
      "command": "rustdocs_mcp_server",
      "args": [
        "async-stripe@0.40",
        "-F",
        "runtime-tokio-hyper-rustls"
      ]
    }
  }
}