Simple Files Vector Store Server

Simple Files Vector Store Server

一个非常简单的向量存储,提供监视目录列表的功能,并自动将目录中所有的 Markdown、HTML 和文本文件索引到向量存储中,以增强上下文。

编程文档访问
访问服务器

README

@lishenxydlgzs/simple-files-vectorstore

一个模型上下文协议 (MCP) 服务器,提供跨文件的语义搜索功能。此服务器会监视指定的目录并创建文件内容的向量嵌入,从而实现跨文档的语义搜索。

安装与使用

添加到您的 MCP 设置文件中:

{
  "mcpServers": {
    "files-vectorstore": {
      "command": "npx",
      "args": [
        "-y",
        "@lishenxydlgzs/simple-files-vectorstore"
      ],
      "env": {
        "WATCH_DIRECTORIES": "/path/to/your/directories"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

MCP 设置文件位置:

  • VSCode Cline 扩展:~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json
  • Claude 桌面应用:~/Library/Application Support/Claude/claude_desktop_config.json

配置

服务器需要通过环境变量进行配置:

必需的环境变量

您必须使用以下方法之一指定要监视的目录:

  • WATCH_DIRECTORIES: 要监视的目录的逗号分隔列表
  • WATCH_CONFIG_FILE: 包含 watchList 数组的 JSON 配置文件路径

使用 WATCH_DIRECTORIES 的示例:

{
  "mcpServers": {
    "files-vectorstore": {
      "command": "npx",
      "args": [
        "-y",
        "@lishenxydlgzs/simple-files-vectorstore"
      ],
      "env": {
        "WATCH_DIRECTORIES": "/path/to/dir1,/path/to/dir2"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

使用 WATCH_CONFIG_FILE 的示例:

{
  "mcpServers": {
    "files-vectorstore": {
      "command": "npx",
      "args": [
        "-y",
        "@lishenxydlgzs/simple-files-vectorstore"
      ],
      "env": {
        "WATCH_CONFIG_FILE": "/path/to/watch-config.json"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

监视配置文件应具有以下结构:

{
  "watchList": [
    "/path/to/dir1",
    "/path/to/dir2",
    "/path/to/specific/file.txt"
  ]
}

可选环境变量

  • CHUNK_SIZE: 用于处理的文本块的大小(默认值:1000)
  • CHUNK_OVERLAP: 块之间的重叠(默认值:200)
  • IGNORE_FILE: 指向 .gitignore 样式文件的路径,用于根据模式排除文件/目录

包含所有可选参数的示例:

  {
    "mcpServers": {
      "files-vectorstore": {
        "command": "npx",
        "args": [
          "-y",
          "@lishenxydlgzs/simple-files-vectorstore"
        ],
        "env": {
          "WATCH_DIRECTORIES": "/path/to/dir1,/path/to/dir2",
          "CHUNK_SIZE": "2000",
          "CHUNK_OVERLAP": "500",
          "IGNORE_FILE": "/path/to/.gitignore"
        },
        "disabled": false,
        "autoApprove": []
      }
    }
  }

MCP 工具

此服务器提供以下 MCP 工具:

1. search

跨索引文件执行语义搜索。

参数:

  • query (必需): 搜索查询字符串
  • limit (可选): 要返回的最大结果数(默认值:5,最大值:20)

示例响应:

[
  {
    "content": "匹配的文本内容",
    "source": "/path/to/file",
    "fileType": "markdown",
    "score": 0.85
  }
]

2. get_stats

获取有关索引文件的统计信息。

参数:无

示例响应:

{
  "totalDocuments": 42,
  "watchedDirectories": ["/path/to/docs"],
  "processingFiles": []
}

特性

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

仓库

GitHub 仓库