file-search-mcp

🚀 文件搜索 MCP

文件搜索 MCP 是一个用 Rust 编写的模型上下文协议（MCP）服务器，专门用于文件系统的全文搜索。它能高效地对指定目录中的文本文件进行全文搜索，还与支持 MCP 的系统兼容，为用户提供便捷的文件搜索体验。

🚀 快速开始

首先，安装 Rust SDK（请从此处下载：https://www.rust-lang.org/）。

克隆此仓库：

git clone git@github.com:Kurogoma4D/file-search-mcp.git

然后将其添加到您的 MCP 设置中（在 Cursor、Claude 等系统中）。

• 命令：<仓库路径>/target/release/file-search-mcp

将 <仓库路径> 替换为您克隆的仓库实际路径。

✨ 主要特性

• 全文搜索：在目录结构中的文本文件中搜索关键字
• 文件内容阅读器：读取并显示特定文本文件的内容
• 智能文件识别：自动识别文本文件并跳过二进制文件
• MCP 集成：与支持模型上下文协议的系统兼容
• 内存索引：创建快速、临时的搜索索引
• 基于评分的结果：返回带有相关性评分的搜索结果

🔧 技术细节

• Rust：用于性能、安全性和并发性
• Tantivy：一个由 Rust 编写的全文搜索引擎库
• RMCP：Rust 实现的模型上下文协议
• Tokio：Rust 的异步运行时

📚 详细文档

🔄 工作原理

1. 服务器对指定目录中的文本文件进行索引，排除二进制文件
2. 处理文本文件内容并将其添加到 Tantivy 内存索引中
3. 当执行搜索时，查询索引以查找匹配项，并根据相关性对其进行排序
4. 返回结果，包括文件路径和相关性评分
5. 文件内容阅读器工具允许您通过提供其路径来查看特定文本文件的内容

🛠️ 可用工具

搜索工具

• 描述：在指定目录中的文本文件中搜索关键字
• 参数：
  • directory：要搜索的目录路径
  • keyword：要搜索的关键字

文件内容阅读器工具

• 描述：读取并显示特定文件的内容
• 参数：
  • file_path：要读取的文件路径

📄 许可证

MIT License

🙏 致谢

• Tantivy 团队，感谢其提供的全文搜索引擎
• RMCP 团队，感谢其对模型上下文协议的实现