article
README
🚀 一个基于 Rust 的文档 MCP 服务器
这是一个 MCP(模型上下文协议)服务器,专为提供对 docs.rs 文档的访问权限而设计。借助该服务器,AI 工具能够便捷地搜索文档、类型信息、功能标志、版本号以及符号定义/源代码。
🚀 快速开始
该服务器实现了模型上下文协议,可与任何 MCP 客户端配合使用。若要将客户端配置为连接到此服务器,需在客户端中进行相应设置。
✨ 主要特性
- 🔍 搜索 docs.rs 上的 crate
- 📄 获取特定 crate 和其版本的文档
- 📋 获取类型信息(结构体、枚举、 trait 等)
- 🚩 获取 crate 的功能标志
- 🔖 获取 crate 的可用版本号
- 💻 获取特定项的源代码
- 🔎 在 crate 中搜索符号
📦 安装指南
该项目使用 Bun 进行开发,但构建后的服务器可以使用 Node.js 运行。
# 克隆仓库
git clone https://github.com/yourusername/rust-docs-mcp-server.git
cd rust-docs-mcp-server
# 安装依赖项
bun install
🛠️ 构建步骤
# 构建服务器
bun run build
这将创建一个构建目录,其中包含编译后的 JavaScript 文件。
💻 使用示例
基础用法
# 运行开发服务器
bun run dev
# 或运行构建后的服务器
bun run start
可用工具
该服务器提供了以下工具:
search_crates:搜索 docs.rs 上的 crateget_crate_documentation:获取特定 crate 的文档get_type_info:获取特定项目的类型信息get_feature_flags:获取 crate 的功能标志get_crate_versions:获取 crate 的可用版本号get_source_code:获取特定项的源代码search_symbols:在 crate 中搜索符号
🧪 测试方法
# 运行测试
bun test
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫