@lishenxydlgzs/simple-files-vectorstore

@lishenxydlgzs/simple-files-vectorstore

site icon
2025.04.01 17
TypeScript语义搜索文件索引知识管理内容生成
simple-files-vectorstore 是一个基于 Model Context Protocol (MCP) 的服务,提供跨文件的语义搜索能力。该服务通过监控指定目录并创建文件内容的向量嵌入,实现对文档的语义搜索。
View on GitHub

Overview

基本能力

产品定位

simple-files-vectorstore 是一个提供语义搜索能力的文件内容索引服务,适用于需要跨文档进行语义搜索的场景。

核心功能

  • 实时文件监控和索引
  • 使用向量嵌入进行语义搜索
  • 支持多种文件类型
  • 可配置的文本块大小和重叠
  • 后台文件处理
  • 自动处理文件变更和删除

适用场景

  • 跨文档的语义搜索
  • 文件内容的知识管理
  • 文档内容分析和检索

MCP 工具列表

  1. search: 执行跨索引文件的语义搜索
  2. 参数: query (必需), limit (可选)
  3. 返回: 匹配的文本内容、文件路径、文件类型和匹配分数
  4. get_stats: 获取索引文件的统计信息
  5. 参数: 无
  6. 返回: 总文档数、监控目录列表、正在处理的文件列表

常见问题解答

  • 如何指定监控目录? 通过 WATCH_DIRECTORIES 环境变量或 WATCH_CONFIG_FILE 配置文件指定
  • 如何排除特定文件? 使用 IGNORE_FILE 环境变量指定 .gitignore 风格的文件
  • 如何调整文本处理参数? 通过 CHUNK_SIZECHUNK_OVERLAP 环境变量配置

使用教程

使用依赖

  • Node.js 环境
  • npm 或 yarn 包管理器

安装教程

  1. 在 MCP 配置文件中添加以下内容:
{
  "mcpServers": {
    "files-vectorstore": {
      "command": "npx",
      "args": [
        "-y",
        "@lishenxydlgzs/simple-files-vectorstore"
      ],
      "env": {
        "WATCH_DIRECTORIES": "/path/to/your/directories"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}
  1. 配置文件位置:
  2. VSCode Cline Extension: ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
  3. Claude Desktop App: ~/Library/Application Support/Claude/claude_desktop_config.json

调试方式

  1. 检查服务是否运行:
ps aux | grep simple-files-vectorstore
  1. 获取索引统计信息:
curl -X POST http://localhost:<port>/get_stats
  1. 执行测试搜索:
curl -X POST -H "Content-Type: application/json" -d '{"query":"test search"}' http://localhost:<port>/search

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。