# AI 编辑器配置指南

本文档详细介绍 Code Search MCP 在不同 AI 编辑器中的配置方法。

---

## 1. Claude Code (Recommended)

### 安装

```bash
pip install code-search-mcp
```

### 配置

#### 方式 1: 通过 settings.json

在 `~/Library/Application Support/Claude/settings.json` 中添加：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

#### 方式 2: 通过项目 .mcp.json

在项目根目录创建 `.mcp.json`：

```json
{
  "code-search": {
    "command": "python",
    "args": ["-m", "code_search_mcp"]
  }
}
```

### 验证

```bash
# 测试 MCP 服务器
python -m code_search_mcp

# 或者使用 Claude Code
# 在对话中直接使用工具
```

---

## 2. Cursor

### 安装

```bash
pip install code-search-mcp
```

### 配置

#### 方式 1: Settings → MCP

1. 打开 Cursor 设置
2. 找到 "MCP Servers" 或 "Extensions"
3. 添加新的 MCP 服务器：

```
Name: code-search
Command: python
Arguments: -m code_search_mcp
```

#### 方式 2: 通过 cursor.config.json

在项目根目录创建 `.cursor/mcp.json`：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

### 使用

在 Cursor 中：
- 使用 Cmd+K 触发 AI 助手
- 直接请求索引或搜索

---

## 3. VS Code + Copilot

### 安装

```bash
pip install code-search-mcp
```

### 配置

需要使用 `mcp-for-vscode` 扩展：

1. 安装 VS Code 扩展：`mcp-for-vscode`
2. 在项目根目录创建 `.vscode/mcp.json`：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

或者通过用户设置：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

### 使用

- 使用 GitHub Copilot Chat
- 请求 Code Search 工具帮助

---

## 4. Zed

### 安装

```bash
pip install code-search-mcp
```

### 配置

Zed 使用 JSON 配置文件：

1. 打开 Zed 设置
2. 找到 "MCP Servers"
3. 添加：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

或者在项目根目录创建 `zed.json`：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

---

## 5. JetBrains (IDEA, PyCharm, WebStorm)

### 安装

```bash
pip install code-search-mcp
```

### 配置

使用 `jetbrains-mcp` 插件：

1. 安装 JetBrains 插件：`MCP Bridge`
2. 配置 `mcp.json`：

在项目根目录创建 `.mcp.json`：

```json
{
  "code-search": {
    "command": "python",
    "args": ["-m", "code_search_mcp"]
  }
}
```

或者全局配置：

```
Settings → Tools → MCP Servers → Add
Name: code-search
Command: python
Arguments: -m code_search_mcp
```

---

## 6. Windsurf (Codeium)

### 安装

```bash
pip install code-search-mcp
```

### 配置

Windsurf 使用 `.windsurfrules` 或配置文件：

1. 打开 Windsurf 设置
2. 找到 MCP 配置
3. 添加：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

---

## 7. Continue (VS Code / JetBrains)

### 安装

```bash
pip install code-search-mcp
```

### 配置

在 `config.json` 中添加：

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

---

## 8. 本地运行测试

### 测试 MCP 服务器

```bash
# 方式 1: 直接运行
python -m code_search_mcp

# 方式 2: 使用 npx (需要 Node.js)
npx -y @modelcontextprotocol/inspector python -m code_search_mcp
```

### 验证安装

```python
from mcp import ClientSession, StdioServerParameters
import asyncio

async def test():
    params = StdioServerParameters(
        command="python",
        args=["-m", "code_search_mcp"]
    )

    async with ClientSession(params) as session:
        await session.initialize()

        # 测试工具列表
        tools = await session.list_tools()
        print(f"可用工具: {[t.name for t in tools]}")

        # 测试索引
        result = await session.call_tool("index_repository", {
            "repo_path": ".",
            "force_rebuild": True
        })
        print(f"索引结果: {result}")

asyncio.run(test())
```

---

## 9. 常见问题

### 问题：找不到 python 命令

**解决**: 使用完整路径

```json
{
  "command": "/usr/local/bin/python3",
  "args": ["-m", "code_search_mcp"]
}
```

### 问题：模块未找到

**解决**: 确保已安装

```bash
pip install code-search-mcp
```

### 问题：连接超时

**解决**: 检查 Python 环境

```bash
# 验证模块存在
python -c "import code_search_mcp; print('OK')"
```

---

## 10. 环境管理

### 使用虚拟环境

```bash
# 创建虚拟环境
python -m venv .venv
source .venv/bin/activate

# 安装
pip install code-search-mcp

# 配置中使用
{
  "command": ".venv/bin/python",
  "args": ["-m", "code_search_mcp"]
}
```

### 使用 uv

```bash
# 使用 uv 运行
{
  "command": "uv",
  "args": ["run", "--with", "code-search-mcp", "python", "-m", "code_search_mcp"]
}
```

---

## 11. 多项目配置

### 全局配置

在用户主目录配置，作用于所有项目：

```
~/.config/code-search-mcp/settings.json
```

### 项目级配置

在项目根目录配置：

```
./.mcp.json
```

---

## 12. 性能优化

### 使用 uvx (推荐)

```json
{
  "command": "uvx",
  "args": ["code-search-mcp"]
}
```

### 使用 pnpm

```json
{
  "command": "pnpm",
  "args": ["exec", "python", "-m", "code_search_mcp"]
}
```

---

## 13. 快速配置模板

### Claude Code (最简)

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

### 带环境变量

```json
{
  "mcpServers": {
    "code-search": {
      "command": "python",
      "args": ["-m", "code_search_mcp"],
      "env": {
        "CODE_INDEX_PATH": "/custom/index/path"
      }
    }
  }
}
```

### 带绝对路径

```json
{
  "mcpServers": {
    "code-search": {
      "command": "/Users/zeng/.pyenv/versions/3.12/bin/python",
      "args": ["-m", "code_search_mcp"]
    }
  }
}
```

---

## 14. 验证清单

配置完成后，验证以下内容：

- [ ] `python -m code_search_mcp` 能正常运行
- [ ] 编辑器能识别 MCP 工具
- [ ] `index_repository` 工具可用
- [ ] `find_files` 工具可用
- [ ] `find_symbols` 工具可用
- [ ] `find_content` 工具可用

---

## 15. 编辑器对比

| 编辑器 | 配置难度 | MCP 支持 | 推荐度 |
|--------|----------|----------|--------|
| Claude Code | ⭐ | 原生 | ⭐⭐⭐⭐⭐ |
| Cursor | ⭐⭐ | 插件 | ⭐⭐⭐⭐ |
| VS Code | ⭐⭐ | 插件 | ⭐⭐⭐ |
| Zed | ⭐⭐ | 原生 | ⭐⭐⭐⭐ |
| JetBrains | ⭐⭐⭐ | 插件 | ⭐⭐⭐ |
| Windsurf | ⭐⭐ | 原生 | ⭐⭐⭐⭐ |
