本地文件全文搜索服务

一个基于Tantivy的本地文件全文索引搜索服务,支持模糊匹配、通配符、短语和布尔运算符。

  • by ping98k
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 ping98k/local-file-search-mcp

使用说明

本地文件搜索mcp

MCP服务器,用于使用Tantivy在本地文件中进行索引全文搜索。支持模糊匹配、通配符、短语和布尔运算符。

安装

在可编辑模式下安装软件包:

pip install -e .

用法

使用搜索路径参数运行服务器:

local-file-search-mcp <search_path> [--full-path]

选项:

  • --full-path:在输出中使用完整的系统路径,而不是相对路径(默认值:false)

例子:

local-file-search-mcp "C:/Users/pingk/OneDrive/Desktop/knowledge"

完整路径:

local-file-search-mcp "C:/Users/pingk/OneDrive/Desktop/knowledge" --full-path

配置

添加到MCP设置中:

"mcpServers": {
    "local-search": {
      "command": "local-file-search-mcp",
      "args": [
        "C:/Users/pingk/OneDrive/Desktop/knowledge"
      ]
    }
}

启用完整路径后:

"mcpServers": {
    "local-search": {
      "command": "local-file-search-mcp",
      "args": [
        "C:/Users/pingk/OneDrive/Desktop/knowledge",
        "--full-path"
      ]
    }
}

工具

搜索_内容

使用索引全文搜索在文件中搜索文本。模糊匹配会自动为单字查询启用。

参数:

  • query (必填):搜索查询。您可以使用运算符手动编写查询:
    • 模糊匹配: term~2 (允许2个字符的差异)
    • 通配符: test* (前缀匹配)
    • 短语: "exact phrase"
    • 布尔值: term1 AND term2, term1 OR term2
  • globPattern (可选):相对于搜索路径的文件全局模式(例如,'.py','数据/“,”src//.js)。默认搜索所有文件。
  • skip (可选):跳过前N个匹配项(默认值:0)

read_file_chunk

从文件中读取围绕特定字符偏移的文本块。返回大约1000个字符(偏移量前100个字符,偏移量后900个字符)。

参数:

  • filePath (必填):文件路径(相对于搜索路径或绝对路径)
  • charOffset (必填):文件中的字符偏移

list_directory_contents

列出指定路径下的文件和目录。返回具有大小的文件夹和文件。

参数:

  • path (可选):相对于搜索路径的目录路径(空或“/”表示根)