Simple File Vector Store

🚀 @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 Desktop 應用程序：~/Library/Application Support/Claude/claude_desktop_config.json

✨ 主要特性

• 支持大語言模型（LLM）的文件內容分析
• 提供高效的語義搜索能力
• 具備可擴展性，支持大量文檔的索引和檢索

📦 安裝指南

服務器需要通過環境變量進行配置，以下是詳細說明：

必要的環境變量

您必須使用其中一種方法指定要監控的目錄：

• 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": []
    }
  }
}

watch 配置文件應具有以下結構：

{
  "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": "200",
        "IGNORE_FILE": "/path/to/ignore-file.txt"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

📚 詳細文檔

MCP 工具

搜索工具（Search Tool）

• 名稱：search
• 參數：
  • query：要搜索的查詢字符串
  • maxResults：最大返回結果數，默認為 5
• 響應：

{
  "results": [
    {
      "id": string,
      "score": number,
      "content": string
    }
  ]
}

• 示例：

curl -X POST http://localhost:1234/mcp/v1/tools/search \
  -H "Content-Type: application/json" \
  -d '{"query":"查詢字符串", "maxResults":5}'