项目简介

'mcp-rust-docs' 是一个基于 Model Context Protocol (MCP) 的服务器，旨在为大型语言模型 (LLM) 提供 Rust 编程语言的上下文信息。它通过 'lookup_crate_docs' 工具，允许 LLM 查询 Rust crate 的文档，从而更好地理解和生成 Rust 代码。

主要功能点

• 查询 Rust crate 文档：可以根据 crate 名称从 docs.rs 获取最新的文档。
• 格式化文档内容：去除 HTML 标签，提取纯文本内容，并限制返回内容的大小，避免客户端过载。
• 标准 MCP 协议：使用 MCP SDK 构建，易于集成到支持 MCP 协议的 LLM 应用中。

安装步骤

1. 克隆仓库：

   git clone https://github.com/0xKoda/mcp-rust-docs.git
   

2. 进入目录：

   cd mcp-rust-docs
   

3. 安装依赖：

   npm install
   

服务器配置

要将此 MCP 服务器集成到 MCP 客户端（例如 Claude Desktop），您需要配置服务器连接信息。以下是一个示例 'claude_desktop_config.json' 配置文件片段，展示了如何配置 'rust-docs' 服务器：

{
  "mcpServers": {
    "rust-docs": {
      "command": "node",
      "args": ["/absolute/path/to/index.js"]  // 请将 "/absolute/path/to/index.js" 替换为 index.js 文件的绝对路径
    }
  }
}

配置参数说明：

• 'server name': 'rust-docs' (服务器名称，客户端用于标识和调用)
• 'command': 'node' (启动服务器的命令，这里使用 Node.js 运行 JavaScript 代码)
• 'args': '["/absolute/path/to/index.js"]' (传递给启动命令的参数，指定 'index.js' 文件的绝对路径)

请务必将 '/absolute/path/to/index.js' 替换为您本地 'index.js' 文件的实际绝对路径。

基本使用方法

1. 启动服务器： 在仓库目录下，运行以下命令启动 MCP 服务器：

   npm start
   

2. 配置 MCP 客户端： 根据您的 MCP 客户端（如 Claude Desktop）的文档，配置连接到本地 MCP 服务器。您需要提供上面 服务器配置 中描述的服务器名称、启动命令和参数。

3. 使用 'lookup_crate_docs' 工具： 在 MCP 客户端中，您可以指示 LLM 使用 'lookup_crate_docs' 工具来查询 Rust crate 文档。例如，您可以向 LLM 提问：

   • "查找 tokio crate 的文档"
   • "serde crate 提供了哪些功能？"
   • "显示 ratatui 的文档"

   LLM 应该能够识别并调用 'lookup_crate_docs' 工具，并利用该工具返回的文档内容来回答您的问题。