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 模式，查看本地向量搜索的效果！