关键词

Rust文档crates.iodocs.rs代码库开发者工具

Rust Docs MCP Server 使用说明

项目简介

Rust Docs MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，旨在为 AI 工具提供访问 Rust 编程语言官方文档 (docs.rs) 的能力。通过此服务器，AI 可以检索 Rust 代码库 (Crates)，获取文档内容，查询类型信息，了解特性标记，以及获取源码等，从而更好地理解和使用 Rust 生态系统。

主要功能点

  • 搜索 Rust 代码库 (Crates)：根据关键词在 crates.io 上查找 Rust 代码库。
  • 获取代码库文档：获取指定代码库及其版本的详细文档内容。
  • 查询类型信息：获取 Rust 类型（如 Struct, Enum, Trait 等）的详细信息，包括定义、描述等。
  • 获取特性标记 (Feature Flags)：查询代码库支持的特性标记及其说明。
  • 获取代码库版本列表：获取代码库在 crates.io 上发布的所有版本信息。
  • 获取源代码：获取指定代码项的源代码内容。
  • 搜索符号 (Symbols)：在代码库中搜索函数、结构体、枚举等符号。

安装步骤

  1. 克隆仓库 
    git clone https://github.com/laptou/rust-docs-mcp-server.git
cd rust-docs-mcp-server
  2. 安装依赖 
    bun install
  3. 构建项目 
    bun run build

服务器配置

MCP 客户端需要配置以下信息以连接到 Rust Docs MCP Server：

{
  "serverName": "rust-docs",
  "command": "bun",
  "args": ["run", "start"]
}
  • 'serverName': MCP 服务器的名称，客户端用以识别，这里设置为 "rust-docs"。
  • 'command': 启动 MCP 服务器的命令，这里使用 'bun' 运行 'start' 脚本。
  • 'args': 启动命令的参数，'start' 脚本会启动编译后的服务器代码。

请确保你的 MCP 客户端能够执行 'bun run start' 命令来启动服务器。

基本使用方法

  1. 启动服务器：在仓库根目录下运行 'bun run start' 命令启动 Rust Docs MCP Server。
  2. 配置 MCP 客户端：将上述服务器配置信息填入 MCP 客户端的服务器配置中。
  3. 使用工具：客户端成功连接服务器后，即可调用服务器提供的工具来查询 Rust 文档信息。例如，可以使用 'search_crates' 工具搜索代码库，使用 'get_crate_documentation' 工具获取代码库文档等。具体工具列表请参考仓库 'README.md' 文件或服务器返回的工具列表。

信息

分类

开发者工具

访问项目