Rust Docs MCP Server

🚀 Rust 文档 MCP 服务器

本项目是一个 MCP（模型上下文协议）服务器，可提供对 docs.rs 上 Rust 文档的访问权限。借助该服务器，AI 工具能够搜索文档、类型信息、功能标志、版本号以及符号定义/源代码。

🚀 快速开始

本服务器可让你轻松访问 docs.rs 上的 Rust 文档。以下是使用前的准备步骤：

1. 克隆仓库：

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

2. 安装依赖项：

bun install

3. 构建服务器：

bun run build

这将创建一个构建目录，其中包含编译后的 JavaScript 文件。 4. 运行服务器：

# 运行开发服务器
bun run dev

# 或运行构建后的服务器
bun run start

✨ 主要特性

• 在 docs.rs 上搜索 crate
• 获取特定 crate 和其版本的文档
• 获取类型信息（结构体、枚举、特质等）
• 获取 crate 的功能标志
• 获取 crate 的可用版本
• 获取特定项的源代码
• 在 crate 中搜索符号

📦 安装指南

该项目使用 Bun 进行开发，但构建后的服务器可以使用 Node.js 运行。安装步骤如下：

# 克隆仓库
git clone https://github.com/yourusername/rust-docs-mcp-server.git
cd rust-docs-mcp-server

# 安装依赖项
bun install

💻 使用示例

基础用法

此服务器实现了模型上下文协议，并且可以与任何 MCP 客户端一起使用。要将客户端配置为连接到此服务器，请按照以下步骤操作。该服务器提供了以下工具：

• search_crates：在 docs.rs 上搜索 crate
• get_crate_documentation：获取特定 crate 的文档
• get_type_info：获取特定项的类型信息
• get_feature_flags：获取 crate 的功能标志
• get_crate_versions：获取 crate 的可用版本
• get_source_code：获取特定项的源代码
• search_symbols：在 crate 中搜索符号

🔧 技术细节

该项目使用 Bun 进行开发，但构建后的服务器可以使用 Node.js 运行。通过上述的安装、构建和运行步骤，你可以轻松部署和使用该服务器，实现对 docs.rs 上 Rust 文档的各种操作。

📄 许可证

本项目采用 MIT 许可证。