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 團隊，感謝其對模型上下文協議的實現