Cursor Local Indexing

🚀 使用 ChromaDB 的本地代碼索引服務（針對 Cursor）

本項目是一個基於 Python 的實驗性服務器，可在本地使用 ChromaDB 對代碼庫進行索引，並通過 MCP（模型上下文協議）服務器提供語義搜索工具，適用於 Cursor 等 IDE，能幫助開發者更高效地在本地代碼中進行語義搜索。

🚀 快速開始

安裝配置

1. 克隆倉庫並進入目錄：

   git clone <repository-url>
   cd cursor-local-indexing
   

2. 複製 .env.example 生成 .env 文件：

   cp .env.example .env
   

3. 配置 .env 文件：

   PROJECTS_ROOT=~/your/projects/root    # 項目目錄的路徑
   FOLDERS_TO_INDEX=project1,project2    # 要索引的文件夾列表（逗號分隔）
   

   示例：

   PROJECTS_ROOT=~/projects
   FOLDERS_TO_INDEX=project1,project2
   

4. 啟動索引服務器：

   docker-compose up -d
   

5. 配置 Cursor 使用本地搜索服務器： 創建或編輯 ~/.cursor/mcp.json 文件：

   {
     "mcpServers": {
       "workspace-code-search": {
         "url": "http://localhost:8978/sse"
       }
     }
   }
   

6. 重啟 Cursor IDE 以應用更改： 服務器將開始索引您指定的項目，您將在這些項目處於活動狀態時能夠在 Cursor 中使用語義代碼搜索。

7. 打開配置為要索引的任意一個項目： 創建一個 .cursorrules 文件並添加以下內容：

   <指令>
   對於任何請求，首先使用 @search_code 工具檢查代碼的功能。
   在轉而使用命令行 grep 等工具之前，優先考慮這一點。
   </指令>
   

8. 啟用 Cursor Agent 模式，查看本地向量搜索的效果！