File Search MCP

File Search MCP

一个专用于在文件系统中进行全文搜索的模型上下文协议（MCP）服务，使用 Rust 构建。

🔍 概述

File Search MCP 是一款工具，可在指定目录中的文本文件内进行强大的全文搜索。它使用 Tantivy 搜索引擎，高效地为文本内容建立索引并进行搜索。

本项目实现了模型上下文协议（MCP），因此兼容支持该协议的 AI 助手和其他系统。

✨ 功能

• 全文搜索：在目录结构中的文本文件内搜索关键词
• 文件内容读取器：读取并显示指定文本文件的内容
• 智能文件检测：自动识别文本文件并跳过二进制文件
• MCP 集成：可与支持模型上下文协议的系统配合使用
• 内存索引：为搜索操作创建快速的临时索引
• 基于分数的结果：返回带有相关性分数的搜索命中结果

🛠️ 技术栈

• Rust：提供性能、安全性和并发能力
• Tantivy：Rust 全文搜索引擎库
• RMCP：模型上下文协议的 Rust 实现
• Tokio：Rust 异步运行时

📋 使用方法

首先，从这里安装 Rust SDK。

克隆此仓库。

git clone [email protected]:Kurogoma4D/file-search-mcp.git

然后将以下内容添加到 MCP 设置中（例如在 Cursor、Claude 中）。

• command: <path-to-repo>/target/release/file-search-mcp

将 <path-to-repo> 替换为克隆后的仓库路径。

🔄 工作原理

1. 服务为指定目录中的文本文件建立索引，并排除二进制文件
2. 它处理文本文件的内容，并将其添加到内存中的 Tantivy 索引
3. 执行搜索时，它会查询索引以查找匹配项，并按相关性对结果排序
4. 返回的结果包含文件路径和相关性分数
5. 文件内容读取器工具允许你提供文件路径，以查看任何文本文件的内容

🛠️ 可用工具

搜索工具

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

文件内容读取器工具

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

📄 许可证

MIT 许可证

🙏 致谢

• 感谢 Tantivy 提供全文搜索引擎
• 感谢 RMCP 提供模型上下文协议实现