ACE-MCP
README.md
# ace-mcp
`ACE` 是 **Aggregated（聚合） + Contextual（上下文） + Embedding（嵌入）** 的缩写。
本地代码搜索 `MCP Server`，面向 `Java`、`JavaScript/TypeScript`、`.NET/C#`、`Python` 项目，支持本地扫描、增量索引、全文/符号/路径搜索，并通过标准 `MCP` 协议把结果提供给 AI 客户端。
当前版本：`v4.10.8`
更新日志见 [`CHANGELOG.md`](./CHANGELOG.md)。
架构图见 [`ace-mcp-architecture.html`](./ace-mcp-architecture.html)。
仓库地址：[Gitee](https://gitee.com/AndrewFengCode/ace-mcp) · [GitHub](https://github.com/0215AndrewFeng/ACE-MCP)
## 核心功能
### 代码搜索
- 本地项目扫描与 `.gitignore` 过滤
- 增量索引，多项目文件监听自动重新索引（默认 2000ms 防抖、10000ms 最大等待）
- `SQLite + FTS5` 全文检索
- 语义召回（本地语义词扩展 + 远程 Embedding API 支持）
- 懒加载向量索引与项目级向量缓存
- 结构化查询语言：`AND` / `OR` / `NOT` + `symbol:` / `path:` / `content:`
- JavaScript/TypeScript AST 级分析，支持 `.vue` / `.svelte` 单文件组件 `<script>` 脚本块索引、Vue Options API 成员符号提取与模板/markup usage 抽取，Java / Python / .NET 增强轻量符号、import、usage 抽取
- Markdown 标题作为 `section` 符号索引，fenced code 示例中的标识符作为 usage 索引，提升文档/RAG 召回
- 语言级 definition/reference 解析、跨文件引用精度提升与多跳调用关系图
- 搜索质量指标：`passRate` / `top1Recall` / `top5Recall` / `meanReciprocalRank`
- 搜索结果可操作化：Web 搜索结果和问答来源卡片支持复制路径、复制引用（`path:line`）和复制代码片段，并支持展开/收起命中解释
- 懒加载上下文预览：Web 搜索结果和问答来源卡片可点击“更多上下文”，按需读取命中行前后代码，metadata 模式也能继续定位源码
- IDE / Agent 定位闭环：Web 搜索结果和问答来源卡片支持复制绝对路径、打开 VS Code、打开 IDEA，并复制“发送到 Codex / 发送到 Claude”的交接提示词
- 结果上下文打包：Web 搜索结果和问答来源卡片支持多选后复制上下文包，并可在复制前填写任务说明或选择任务草稿，用于多文件交接给 Codex/Claude
- 查询/任务模板：Web 搜索和智能问答输入框提供“查调用链”“查影响面”“找潜在 bug”“补单元测试”“梳理业务流程”等快捷模板
- 搜索结果命中解释：Web 搜索结果和问答来源卡片展示 `reason`、`score`、路径/符号/片段/关键词命中，直接说明“为什么命中”
- 项目级搜索画像：汇总文件、代码块、符号、语言、摘要、向量覆盖和最近索引失败，给出召回诊断建议；画像修复结果可见化，展示修复前后变化和失败文件明细
- 自动识别项目：Web 搜索和智能问答默认根据问题关键词路由到已索引项目，高置信结果自动继续，多个候选或证据不足时停止并展示状态；候选召回按项目公平配额，项目内重复证据按边际递减计分；混合 ASCII/CJK 业务词保持完整，精确证据可结合仓库名锚点召回同族项目，避免通用词、复制枚举或测试夹具主导归属；手动选择项目仍可覆盖自动路由
- 有界路由证据：SQLite 直接返回 FTS 高亮推导出的 `matchedTerms`，关键词覆盖不再从截断 snippet 或子串反推；查询最长 4096 字符，最多传递 32 个 route terms 和 16 个 identifiers（单项最长 120 字符），每项目最多召回 20 条原始证据、输出 5 条证据，每条匹配文本最多 4096 字符
- 父子项目自动维护：自动索引跳过拥有两个及以上已登记后代项目的聚合父目录，避免父子重复扫描；删除项目后立即刷新 ownership，并用单调 sequence 防止较早的异步刷新覆盖新拓扑；单一嵌套子项目和显式父目录索引仍按原行为工作
- Git clean fast path：周期校准仅在 watcher 活跃且干净、Git 状态与 HEAD 读取可靠、没有失败或在途任务时跳过文件收集；启动、脏工作区和任何不可靠状态仍走保守增量路径
- Git dirty 稳定增量：dirty 和 untracked 路径仍经过已有文件指纹校验，长期未提交但内容未再变化的文件不会在每次周期校准中重复重建；新增文件和真实指纹变化仍会正常索引
- 跨进程索引写入协调：Web startup/periodic catch-up 和 watcher 自动索引持有可续租 maintenance lease；stdio MCP freshness 在有效 lease 期间直接复用最后成功索引，Web owner 异常退出或 lease 过期后恢复按需索引
- 有限 SQLite search worker pool：一次 worker 请求合并 lexical、semantic FTS、unicode、symbol、path 和 identifier boost 候选，默认 2 个 reader、最多排队 64 个请求，并以 5 秒总 deadline 和显式 503 overload/timeout 保护服务
- watcher 资源预算：自动维护默认只保留 8 个 root-only watcher，超额项目降级为 `periodic-only` 并继续参加 startup/periodic reconciliation；创建失败采用有界退避、重试上限和全局熔断，避免 `EMFILE` 热循环
- maintenance lease 主动续租：lease 控制使用独立 SQLite worker，每个持久化阶段前校验 fencing，并在剩余 TTL 不足时主动续租，长事务不再把本进程误报为其他 owner
- 有界启动维护：约 50 个项目的 startup catch-up 一次只提交一个自动任务，显式索引优先于后台维护，`/health` 暴露 active/pending/completed 和当前项目
- 8/16/32 并发门禁：`release:benchmark` 同时验证 idle 与 during-index 搜索 p95/p99、吞吐、队列、超时、错误、非空稳定结果以及 health/resolve 响应性，并对 watcher/lease 异常 fail closed
- 独立索引 worker：SQLite 索引写入、删除、向量、符号图和语义索引工作移出 Web 主事件循环，解析批次主动 yield；搜索 worker 与索引 worker 相互独立，搜索请求绑定创建它的 worker generation，幂等 close 会拒绝新请求并等待所有存活 worker，旧 worker 的迟到 exit 不会干扰替代 worker
- 索引 phase 诊断：`/health` 展示 active/queued 索引的 `phase`、`origin`、`queueMs`、`phaseElapsedMs` 和进度，完成事件记录 prepare/parse/write/vector/symbolGraph/semantic/finalize 等分段耗时
- 有界日志：`logLevel` 同时约束文件与 stderr；结构化日志单文件上限 20 MiB，最多保留 3 个归档，主进程与 SQLite workers 通过原子锁协调轮转；磁盘、序列化和 stderr EPIPE 失败不会反向打崩服务
### 智能问答 (RAG)
- **LLM 流式问答**：SSE 逐 token 显示，支持多轮对话追问
- **调用链分析**：自动提取搜索结果中符号的上下游调用关系，作为额外上下文传递给 LLM
- **调用链可视化**：Mermaid 流程图展示函数调用关系
- **可配置参考代码数量**：用户可自行选择检索源数量（1~100），前端选择直接生效
- **可调上下文预算**：Web 问答可按请求设置 `maxContextTokens`，需要更完整参考代码时可直接切到最大值
- **LLM Reranker（可选）**：使用 LLM 对搜索结果二次排序，提升搜索精度
- **LLM 响应缓存**：相同问题 5 分钟内直接返回缓存结果，节省 token
- **代码引用高亮**：`[N]` 引用可点击跳转到对应源码卡片
- **思考过程展示**：DeepSeek 模型的 reasoning_content 实时显示
- **代码摘要生成**：自动生成项目架构概览和模块摘要
- **业务流程图**：问答涉及业务流程/处理逻辑时，答案末尾自动追加 Mermaid 流程图（`flowchart TD`）并渲染为可视化图表
- **流程图/调用链图导出**：渲染后的图可一键下载 PNG、下载 SVG 或复制 Mermaid 源码
### MCP 工具
- `search_context` / `find_definition` / `find_references` / `find_callers` / `find_callees`
- `evaluate_search_quality` / `index_project` / `get_file_snippet` / `project_stats`
- `generate_summary` / `get_summary` / `ask_codebase` / `warm_index`
- `cache_stats` / `clear_project_index` / `list_symbols` / `resolve_projects`
## 使用示例
- Copilot 提示词模板：[`example/copilot-prompts.md`](./example/copilot-prompts.md)
- Claude Code 提示词模板：[`example/claude-code-prompts.md`](./example/claude-code-prompts.md)
## 环境要求
- Node.js `>= 18.18.0`
- npm `>= 9`
- Windows 普通用户建议使用自包含 ZIP，不需要预装 Node.js、npm 或 Visual Studio Build Tools。npm/tgz 安装适合需要自行管理 Node 环境的开发者。
## 推荐安装方式
### npm 全局安装
发布到 npm registry 后可直接安装：
```bash
npm install -g ace-mcp
ace-mcp --version
ace-mcp-web
```
`ace-mcp-web` 等价于使用默认端口启动 Web 面板：
```bash
ace-mcp --web-port 8787
```
可通过环境变量改默认端口：
```bash
ACE_MCP_WEB_PORT=9000 ace-mcp-web
```
### tgz 全局安装
从 v4.10.8 Gitee Release 下载 `ace-mcp-4.10.8.tgz` 安装：
```bash
npm install -g ./ace-mcp-4.10.8.tgz
ace-mcp-web
```
Windows PowerShell：
```powershell
npm install -g .\ace-mcp-4.10.8.tgz
ace-mcp-web
```
### macOS 一键安装
适合首次安装或不熟悉 npm 的用户。脚本会检查 Node.js/npm，缺失时会尝试用 Homebrew 安装 Node.js 22，然后下载 Gitee Release 的 tgz 包并全局安装：
```bash
bash -c "$(curl -fsSL https://gitee.com/AndrewFengCode/ace-mcp/raw/v4.10.8/scripts/install-macos.sh)"
```
安装指定版本：
```bash
ACE_MCP_VERSION=4.10.8 bash -c "$(curl -fsSL https://gitee.com/AndrewFengCode/ace-mcp/raw/v4.10.8/scripts/install-macos.sh)"
```
安装完成后启动 Web 面板：
```bash
ace-mcp-web
```
#### 依赖需求清单
| 依赖 | 要求 | 用途 | 获取方式 |
| --- | --- | --- | --- |
| macOS | 12 或更新版本推荐 | 运行本地服务和安装脚本 | 系统自带 |
| curl | 系统自带即可 | 下载安装脚本和 tgz 包 | 如缺失，运行 `xcode-select --install` |
| Node.js | Node.js >=18.18.0，推荐 22 LTS | 运行 ace-mcp 与 npm 全局安装 | 脚本会尝试 `brew install node@22` |
| npm | 随 Node.js 安装 | 安装 tgz 包和依赖 | 随 Node.js 安装 |
| Homebrew | 可选但推荐 | Node 缺失时自动安装 `node@22` | <https://brew.sh> |
| Xcode Command Line Tools | 仅当原生依赖需要本地编译时需要 | 编译 `better-sqlite3` fallback | `xcode-select --install` |
如果已经装好 Node.js，也可以手动确认：
```bash
node --version
npm --version
```
使用 Gitee Release 的 tgz 包：
```bash
curl -LO https://gitee.com/AndrewFengCode/ace-mcp/releases/download/v4.10.8/ace-mcp-4.10.8.tgz
npm install -g ./ace-mcp-4.10.8.tgz
ace-mcp --version
ace-mcp-web
```
源码运行：
```bash
git clone https://gitee.com/AndrewFengCode/ace-mcp.git
cd ace-mcp
npm install
npm run build
npm start -- --web-port 8787
```
如果 `better-sqlite3` 安装触发本地编译失败，先安装 Xcode Command Line Tools 后重试：
```bash
xcode-select --install
npm install
```
### Windows zip 安装
v4.10.8 Windows ZIP 尚待在 Windows x64 + Node.js 22 主机上构建和验证。产物补齐并发布后，下载 `ace-mcp-v4.10.8-win-x64.zip`，解压后双击 `start-web.cmd`，然后访问 <http://127.0.0.1:8787/>：
```cmd
start-web.cmd
```
发布包已经包含 Node.js 22、生产依赖和 `better-sqlite3` Windows 原生二进制。首次启动不执行 `npm install`，不需要联网下载依赖，也不需要 Visual Studio C++ 工具链。可以先运行 `doctor.cmd` 做离线自检；旧流程中的 `install.cmd` 仍可使用，但现在只执行自检。
MCP 客户端直接配置解压目录内的 `ace-mcp.cmd` 绝对路径，不再配置系统 `node`：
```json
{
"mcpServers": {
"ace-mcp": {
"command": "C:\\Tools\\ace-mcp-v4.10.8-win-x64\\ace-mcp.cmd"
}
}
}
```
详细说明见 [`scripts/README-WINDOWS.md`](./scripts/README-WINDOWS.md)。
### 源码安装
```bash
git clone https://gitee.com/AndrewFengCode/ace-mcp.git
cd ace-mcp
npm install
npm run build
npm start -- --web-port 8787
```
GitHub 镜像：
```bash
git clone https://github.com/0215AndrewFeng/ACE-MCP.git
```
> 启动后访问 http://127.0.0.1:8787/ 即可使用 Web 调试面板。
### Windows 启动脚本
自包含 ZIP 解压后使用：
```cmd
start-web.cmd
start-web.cmd 9000
```
npm/tgz 全局安装后使用：
```powershell
ace-mcp-web
ace-mcp-web 9000
```
源码目录中也提供脚本：
```cmd
scripts\start-web.cmd
scripts\start-web.cmd 9000
```
PowerShell：
```powershell
powershell -ExecutionPolicy Bypass -File .\scripts\start-web.ps1
powershell -ExecutionPolicy Bypass -File .\scripts\start-web.ps1 9000
```
### 本地打包
```bash
npm run release:pack
npm install -g ./ace-mcp-4.10.8.tgz
```
`release:pack` 使用仓库内 `.npm-cache/`，避免本机全局 npm cache 权限问题影响打包。
Windows zip：
```bash
npm run release:win
```
`release:win` 必须在 Windows x64 + Node.js 22 上运行。它会把当前 `node.exe`、裁剪后的生产依赖和已加载验证的 `better-sqlite3` 原生二进制一起打入 ZIP；当前 Darwin 主机不能完成或替代这项验证，v4.10.8 Windows ZIP 尚未补齐。
安装包 smoke test：
```bash
npm run release:smoke
```
`release:smoke` 会验证两条链路：临时全局安装当前 tgz；以及在 PATH 不包含 Node/npm 的隔离环境中解压 Windows ZIP，验证 `ace-mcp --version`、`--doctor` 和 Web `/health`。
搜索 benchmark smoke：
```bash
npm run release:benchmark
```
`release:benchmark` 会启动隔离的临时 Web 服务和 full index，只在 `/health` 确认索引 active 后测量响应性。它要求 active 窗口内至少取得 20 个 `/health` 和 20 个 `/api/projects/resolve` 有效样本，并按 health/resolve p95 与超时阈值决定退出码。
对已经运行的 Web 服务执行真实项目 during-index benchmark：
```bash
npm run benchmark:search -- --base-url http://127.0.0.1:8787 --project /absolute/project/path --query FlowSwitcher --during-index
```
发布前检查本地环境变量里的 Gitee token 是否误入仓库文件、打包产物或 git history。该命令只报告 `redacted`，不会打印 token 内容：
```bash
npm run security:secrets
```
完成 commit、tag、push 和跨平台产物验证后，可用以下命令发布 Gitee Release。命令会用 `GITEE_TOKEN` 调用 Gitee OpenAPI 创建/更新 Release、替换同名 tgz/Windows zip 附件，并在上传后自动执行下载链路验证：
```bash
GITEE_TOKEN=<your-token> npm run release:publish -- --version 4.10.8
```
如需单独验证 tag、tgz、Windows zip 和 macOS 安装脚本下载链接：
```bash
npm run release:verify-assets -- --version 4.10.8
```
## 本地运行
### 安装自检 / 排障
```bash
ace-mcp --doctor
```
`--doctor` 检查 Node/npm、`better-sqlite3`、SQLite FTS5、数据/日志目录写权限、默认 Web 端口和 LLM/Embedding 配置。安装失败、Web 面板打不开、`better-sqlite3` 编译失败或 MCP 客户端找不到命令时，先运行它查看下一步修复建议。
### 搜索质量回归（发版前建议）
将 golden 用例写入 `eval-cases/golden.json`（格式见 `example/eval-cases.example.json`），执行：
```bash
npm run build && npm test && npm run eval
```
`npm run eval` 等价于 `node dist/index.js --eval eval-cases/golden.json`：对每个被测项目增量索引后跑 `evaluate_search_quality`，打印逐用例 PASS/FAIL 与汇总指标（passRate/top1/top5/MRR），任一用例不达 `minPassRate`（默认 1.0）即退出码 1。真实业务用例所在的 `eval-cases/` 已 gitignore，不会入库。
### 全库维护重索引
```bash
npm run maintenance:reindex -- --dry-run
npm run maintenance:reindex -- --summary
```
维护脚本会从 Web 服务 `/api/projects` 读取已登记项目，按顺序逐个 full index；加 `--summary` 后每个成功索引的项目会继续生成摘要。默认跳过不存在路径，以及包含多个已登记子项目的聚合父目录；确需处理父目录时显式加 `--include-parent`。
### 作为 MCP Server 启动
```bash
npm start
```
### 启动 MCP Server 并开启 Web 调试面板
```bash
npm start -- --web-port 8787
```
启动后可访问：
- `http://127.0.0.1:8787/`
- `http://127.0.0.1:8787/health`
- `http://127.0.0.1:8787/api/runtime`
### CLI 参数
| 参数 | 说明 |
|------|------|
| `--web-port <port>` | 启动 HTTP 调试面板，如 `--web-port 8787` |
| `--warm` | 在 readiness 前完成暖机，再开放 MCP/Web 服务，消除首次查询延迟 |
| `--eval <caseFile>` | 跑搜索质量回归（加载 JSON golden 用例文件），打印报告后退出，退出码 0=通过 / 1=不达标 |
| `-v, --version` | 查看当前版本 |
| `-h, --help` | 查看帮助信息 |
| `--autostart enable` | 启用开机自启（macOS launchd / Linux systemd） |
| `--autostart disable` | 禁用开机自启 |
| `--autostart status` | 查看开机自启状态 |
### 开机自启管理
`--autostart` 当前支持 macOS launchd 和 Linux systemd user service。Windows 可先使用任务计划程序手动配置，后续版本再补内置管理。
```bash
# 启用开机自启（同时开启 Web 面板）
node dist/index.js --autostart enable --web-port 8787
# 查看自启状态
node dist/index.js --autostart status
# 禁用开机自启
node dist/index.js --autostart disable
```
### 启动流程
ace-mcp 启动时按以下顺序初始化：
1. **解析 CLI 参数** — `--version`/`--help`/`--autostart` 处理后直接退出
2. **加载配置** — 从 `~/.ace-mcp/settings.toml` 读取配置，支持环境变量覆盖
3. **初始化核心服务** — `Logger`、`SQLiteStore`（建表）、`EmbeddingProvider`、`IndexCoordinator`、`SearchService`、`LlmClient`、`SummaryGenerator`，全部本地初始化无网络依赖
4. **创建 MCP Server** — 注册所有工具，通过 stdin/stdout 与 MCP 宿主通信
5. **可选启动 Web 面板** — 指定 `--web-port` 时启动 Express HTTP 服务
6. **注册信号处理** — `SIGINT`/`SIGTERM` 触发优雅关闭
## MCP 客户端配置示例
以 Claude Desktop 或其他支持 MCP 的客户端为例：
全局安装后：
```json
{
"mcpServers": {
"ace-mcp": {
"command": "ace-mcp"
}
}
}
```
Windows 全局安装后，如果 MCP 宿主找不到 PATH 中的命令，可使用 npm 全局 shim 的绝对路径：
```json
{
"mcpServers": {
"ace-mcp": {
"command": "C:\\Users\\<用户名>\\AppData\\Roaming\\npm\\ace-mcp.cmd"
}
}
}
```
源码运行：
```json
{
"mcpServers": {
"ace-mcp": {
"command": "node",
"args": [
"/Users/fengandrew/code/ace-mcp/dist/index.js"
]
}
}
}
```
若需要同时开启 Web 调试面板：
```json
{
"mcpServers": {
"ace-mcp": {
"command": "node",
"args": [
"/Users/fengandrew/code/ace-mcp/dist/index.js",
"--web-port",
"8787"
]
}
}
}
```
若需要启动时自动暖机已索引项目（消除首次查询延迟）：
```json
{
"mcpServers": {
"ace-mcp": {
"command": "node",
"args": [
"/Users/fengandrew/code/ace-mcp/dist/index.js",
"--warm"
]
}
}
}
```
### Codex 沙箱初始化
Codex 使用 `workspace-write` 沙箱时，默认只能写当前项目和自身声明的可写目录。ace-mcp 的共享数据库位于项目目录外的 `~/.ace-mcp/data/index.db`；如果没有额外授权，首次索引会报 `SqliteError: attempt to write a readonly database`。
npm/tgz 或 macOS 一键安装后运行：
```bash
ace-mcp-configure-codex
```
源码目录可运行：
```bash
node scripts/configure-codex.mjs
```
该命令会保留 `~/.codex/config.toml` 中的其他配置，并幂等地创建或合并：
```toml
[sandbox_workspace_write]
writable_roots = ["/Users/<用户名>/.ace-mcp"]
```
已有 `writable_roots` 不会被覆盖。macOS 一键安装脚本检测到 Codex CLI 或现有 `~/.codex/config.toml` 时会自动执行配置；手工安装则需要运行一次上述命令。修改后请完全重启 Codex 或重连 MCP，使新进程获得更新后的沙箱权限。
### 宿主升级与重连建议
- 升级 `dist/` 或切换到新版本包后，需在 MCP 宿主侧执行一次 **reload / reconnect**，让宿主拉起新的 `ace-mcp` 进程。
- 若怀疑宿主仍连着旧进程，可先执行 `node dist/index.js --version` 确认版本，再访问 `/health` 或 `/api/runtime` 检查当前进程的 `version`、`pid` 与 `uptimeMs`。
- 若宿主需要并行调试，可在配置中加上 `--web-port 8787`，通过 HTTP 接口独立验证。
## 配置文件
首次运行会自动创建：
```text
~/.ace-mcp/
settings.toml
data/index.db
log/ace-mcp.log
```
配置示例：
```toml
autoWatch = true
batchSize = 32
defaultTopK = 8
enableVectorSearch = true
indexConcurrency = 1
indexFreshness = "stale"
indexFreshnessSeconds = 30
maxFileSizeKb = 1024
maxLinesPerChunk = 220
logLevel = "info"
searchWorkerPoolSize = 2
searchWorkerQueueMaxPending = 64
searchWorkerQueueDeadlineMs = 5000
textExtensions = [".java", ".js", ".jsx", ".ts", ".tsx", ".vue", ".svelte", ".cs", ".py", ".md"]
excludePatterns = [".git", "node_modules", "dist", "build", "target", "bin", "obj", "__pycache__", ".venv"]
vectorIndexingMode = "lazy"
watchDebounceMs = 2000
watchMaxWaitMs = 10000
watchReconcileSeconds = 600
# LLM 配置（支持 OpenAI 兼容接口）
llmApiUrl = "https://api.deepseek.com/v1/chat/completions"
llmApiKey = "sk-xxx"
llmModel = "deepseek-reasoner"
llmMaxTokens = 4096
llmTemperature = 0.0
```
自动文件监听与周期校准由显式传入 `--web-port` 的 Web/守护进程统一承担。普通 stdio MCP 进程仍会在工具请求时执行增量索引，但不会重复建立全项目 watcher，从而避免多个 MCP 客户端同时争抢 SQLite 写锁。
也支持环境变量覆盖：
- `ACE_MCP_BATCH_SIZE`
- `ACE_MCP_DEFAULT_TOP_K`
- `ACE_MCP_ENABLE_VECTOR_SEARCH`
- `ACE_MCP_MAX_FILE_SIZE_KB`
- `ACE_MCP_MAX_LINES_PER_CHUNK`
- `ACE_MCP_LOG_LEVEL`
- `ACE_MCP_TEXT_EXTENSIONS`
- `ACE_MCP_EXCLUDE_PATTERNS`
- `ACE_MCP_VECTOR_INDEXING_MODE`
- `ACE_MCP_AUTO_WATCH`
- `ACE_MCP_INDEX_CONCURRENCY`
- `ACE_MCP_INDEX_FRESHNESS`
- `ACE_MCP_INDEX_FRESHNESS_SECONDS`
- `ACE_MCP_WATCH_DEBOUNCE_MS`
- `ACE_MCP_WATCH_MAX_WAIT_MS`
- `ACE_MCP_WATCH_RECONCILE_SECONDS`
- `ACE_MCP_SEARCH_WORKER_POOL_SIZE` - SQLite search reader 数量（默认 2，最大 16）
- `ACE_MCP_SEARCH_WORKER_QUEUE_MAX_PENDING` - 等待执行的搜索请求上限（默认 64，最大 1024）
- `ACE_MCP_SEARCH_WORKER_QUEUE_DEADLINE_MS` - 搜索从入队到 reader 完成的最长时间（默认 5000ms，最大 60000ms）
- `ACE_MCP_LLM_API_URL`
- `ACE_MCP_LLM_API_KEY`
- `ACE_MCP_LLM_MODEL`
#### v4.3.6 新增配置项
Ask Codebase 限制配置（解决查询不准确问题）：
- `ACE_MCP_QA_MAX_SOURCES_DEFAULT` - 默认检索源数量（默认 15）
- `ACE_MCP_QA_MAX_SOURCES_MAX` - 最大检索源数量上限（默认 100）
- `ACE_MCP_QA_MAX_CONTEXT_TOKENS` - LLM 上下文 token 预算（默认 48000；放大可让大接口带更完整代码，受模型上下文窗口约束）
- `ACE_MCP_QA_MAX_CONTEXT_TOKENS_MAX` - 上下文预算上限，用于钳制按请求传入的 `maxContextTokens`（默认 200000）
- `ACE_MCP_SEARCH_PER_FILE_LIMIT` - 每个文件最多保留的搜索结果数（默认 2）
- `ACE_MCP_SEARCH_FANOUT_MULTIPLIER` - 搜索候选集扩展倍数（默认 3）
### 远程 Embedding API
通过环境变量配置远程 Embedding API，用于语义搜索的向量生成：
```bash
ACE_MCP_EMBEDDING_PROVIDER=remote \
ACE_MCP_EMBEDDING_API_URL=https://api.openai.com/v1/embeddings \
ACE_MCP_EMBEDDING_API_KEY=sk-xxx \
ACE_MCP_EMBEDDING_MODEL=text-embedding-3-small \
ace-mcp --web-port 8787
```
远程 API 请求失败时自动回退到本地内存哈希向量，保证搜索可用性。
## Web 调试面板
Web 面板提供完整的可视化调试体验：
### 智能问答
- **Ask Codebase**：基于 RAG 的代码问答，支持流式输出
- **多轮对话**：自动保留上下文，支持追问
- **代码引用**：`[N]` 引用可点击跳转
- **会话统计**：显示 token 用量和请求次数
- **最大上下文**：高级选项可一键使用最大参考代码数量、最大上下文 token 预算、最大输出、最大超时和最大重试次数
### 代码搜索
- **交互式搜索**：支持所有搜索模式和过滤条件
- **语法高亮**：搜索词和代码语法高亮显示
- **搜索历史**：点击历史记录快速填充
- **上下文扩展**：搜索结果上下文行数上限提升到 500，并提供最大值快捷按钮
### 项目管理
- **项目列表**：持久化存储，支持删除
- **自动项目路由**：未手动选择时先在全部 ready 项目中召回候选，过滤缺失路径和聚合父目录，并返回 `single` / `multiple` / `abstain` 决策、置信度及证据文件
- **索引控制**：手动触发索引和向量预热
- **代码摘要**：生成和查看项目摘要
### 主要接口
- `GET /health` - 健康检查
- `GET /api/runtime` - 运行时信息
- `GET /api/config` - 配置信息
- `GET /api/watch` - 每项目文件监听与 dirty 状态
- `GET /api/tools` - 工具列表
- `GET /api/projects` - 已索引项目
- `POST /api/projects/resolve` - 根据问题关键词解析候选项目，不触发全项目索引
- `GET /api/project-stats` - 项目统计
- `GET /api/project-profile` - 项目级搜索画像与召回诊断
- `POST /api/index-project` - 提交后台索引任务
- `POST /api/watch/start` - 启动指定项目文件监听
- `POST /api/watch/stop` - 停止指定项目监听；不传项目路径时停止全部
- `POST /api/search-context` - 代码搜索
- `POST /api/find-definition` - 定义查找
- `POST /api/find-references` - 引用查找
- `POST /api/find-callers` - 调用者查找
- `POST /api/find-callees` - 被调用者查找
- `POST /api/qa/ask` - 代码问答
- `POST /api/qa/cache/clear` - 清除 QA 缓存
- `GET /api/qa/ask/stream` - 流式问答 (SSE)
- `POST /api/summary/generate` - 提交后台摘要生成任务
- `GET /api/summary` - 获取摘要
- `GET /api/tasks` / `GET /api/tasks/:taskId` - 查询后台长任务状态
- `POST /api/index/warm` - 向量预热
- `GET/POST /api/llm/config` - LLM 配置
## 版本历史
### v4.10.8（当前版本）
- **有限 search worker pool**：lexical、semantic FTS、unicode、symbol、path 与 identifier boost 合并为一次 bounded worker 请求；默认 2 个 reader，队列上限 64，总 deadline 5 秒，overload/timeout 保持为可重试 503
- **watcher 有界覆盖**：默认最多 8 个 root-only watcher，其余自动项目使用 `periodic-only` 覆盖；失败恢复具备单项目 single-flight、指数退避、重试上限和全局熔断，避免 `EMFILE` 重建风暴
- **lease 与长事务修复**：FTS5 按文件批量删除 `UNINDEXED chunk_id`，maintenance lease 在持久化阶段间主动续租并执行 fencing，消除 heartbeat 饥饿及错误的 foreign-owner 状态
- **启动与并发门禁**：49 项目 startup 队列有界收敛；8/16/32 并发和 during-index 基准纳入 `release:benchmark`，超时、错误、空结果、watcher storm 或 lease loss 均 fail closed
- **平台状态**：4.10.8 source、tag 和发布资产状态以 release checklist 与远端实际结果为准；Windows 自包含 ZIP 仍须在 Windows x64 + Node.js 22 主机构建和验证
### v4.10.7
- **Codex 沙箱初始化**：新增 `ace-mcp-configure-codex`，原子且幂等地把 `~/.ace-mcp` 合并到 `[sandbox_workspace_write].writable_roots`，保留已有 roots 和其他 Codex 配置
- **macOS 安装闭环**：一键安装检测到 Codex 后自动配置数据目录写权限，避免首次初始化 SQLite 时出现 `attempt to write a readonly database`
- **失败保护**：Codex TOML 已损坏或 `writable_roots` 类型不合法时拒绝覆盖，并给出明确错误；配置更新后提示重启 Codex
- **平台状态**：4.10.7 source、tag 和发布资产状态以 release checklist 与远端实际结果为准；Windows 自包含 ZIP 仍须在 Windows x64 + Node.js 22 主机构建和验证
### v4.10.6
- **跨进程写入 ownership**：Web startup/periodic catch-up 与 watcher 自动索引在完整维护窗口持有 SQLite maintenance lease，进程内队列不再是唯一协调边界
- **查询优先复用旧索引**：stdio MCP freshness 发现有效 lease 时不启动第二个 writer，立即使用数据库中最后一次成功索引继续搜索
- **崩溃自动恢复**：maintenance lease 每 10 秒续租、60 秒过期；Web owner 退出、崩溃或失去 lease 后，stdio 按需索引恢复执行
- **回归覆盖**：独立 SQLite 连接、真实 index worker IPC、startup catch-up 竞争和过期接管均有自动化测试
- **平台状态**：4.10.6 source、tag 和发布资产状态以 release checklist 与远端实际结果为准；Windows 自包含 ZIP 仍须在 Windows x64 + Node.js 22 主机构建和验证
### v4.10.5
- **Git dirty 稳定增量**：Git 返回的 dirty/untracked 路径继续经过已有文件指纹校验，不再被直接视为必须重建
- **周期校准降载**：长期未提交但内容未再变化的文件不会每 600 秒重复解析、写库和生成向量；新增文件及真实指纹变化仍正常进入索引
- **回归覆盖**：真实 coordinator/SQLite 索引测试覆盖已跟踪 dirty 文件与已建立索引的 untracked 文件
- **平台状态**：4.10.5 source、tag 和发布资产状态以 release checklist 与远端实际结果为准；Windows 自包含 ZIP 仍须在 Windows x64 + Node.js 22 主机构建和验证
### v4.10.4
- **有界日志与等级修复**：`logLevel` 在任何 I/O 前生效，debug 不再绕过 `info` 配置写入文件；日志按 20 MiB 轮转并保留 3 个归档，多个 SQLite worker 使用原子锁协调轮转
- **异常路径不递归**：文件写入、循环 metadata 序列化和 stderr EPIPE 均被 Logger 边界吸收；LaunchAgent/systemd 默认关闭重复 stderr，避免错误处理再次触发 uncaughtException/KeepAlive 循环
- **混合业务词路由**：保留 `A转D` 一类 ASCII/CJK 混合概念，过滤 `to` 等路由停用词；精确混合证据结合查询命中的仓库名建立 ownership 锚点，并召回有代码证据的同族仓库
- **平台状态**：4.10.4 source commit、tag、`master` 和 Gitee tgz Release 已发布并通过公开下载校验；Windows 自包含 ZIP 仍须在 Windows x64 + Node.js 22 主机构建和验证
### v4.10.3
- **父子项目自动维护**：拥有两个及以上已登记后代项目的聚合父目录不再参与自动 catch-up、watcher 校准和周期索引，具体子项目分别维护；显式索引父目录仍可执行
- **Git clean fast path**：可靠 clean Git 项目的周期校准可在 HEAD 未变化且 watcher 状态干净时跳过昂贵文件收集；启动、dirty、失败和不可靠状态保守回退
- **独立索引 worker**：索引侧 SQLite 写入及符号图/语义操作移出主事件循环，解析批次主动 yield；关闭时停止接收新索引并等待活动与排队任务收敛
- **`--warm` readiness 修正**：启用 `--warm` 时在 readiness 前完成暖机和向量缓存预载，并通过 Coordinator 管理的 SQLite worker 补齐 semantic FTS；LaunchAgent 默认不启用 `--warm`，正常启动路径不增加该等待
- **phase 诊断与 during-index 门禁**：`/health` 区分 active/queued phase 并展示队列/阶段耗时；benchmark 仅在观察到 active indexing 时采集至少 20 组 health/resolve 样本并执行 p95/超时门禁
- **平台状态**：4.10.3 source tag 与 `master` 已推送；macOS/tgz 已完成本地打包验证，Windows 自包含 ZIP 仍须在 Windows x64 + Node.js 22 主机构建和验证，Gitee Release 资产尚未发布
### v4.10.2
- **自动项目路由**：新增一次有界的全局候选召回，根据问题关键词返回 `single`、`multiple` 或 `abstain`，并附带置信度、命中词和证据文件
- **Web 默认自动识别**：代码搜索和智能问答在未手动选择项目时先解析项目；只有单项目高置信结果才继续，歧义或证据不足时不会静默选错
- **手动覆盖与安全过滤**：显式项目路径保持最高优先级；路由排除无效路径、非 ready 项目和包含多个已登记子项目的聚合根目录
- **独立质量指标**：项目路由单独统计 decision accuracy、Top-1、Recall@3 和 MRR，不与项目内代码搜索质量混算
### v4.10.1
- **可靠的多项目自动索引**：每项目独立 watcher、debounce/max-wait、generation 追赶、全局并发限制、启动 catch-up 和周期校准共同保证变更不丢失
- **单一自动维护进程**：仅显式 `--web-port` 的 Web/守护进程承担 watcher 和校准，普通 stdio MCP 进程按请求增量索引，避免 SQLite 多进程争锁
- **项目删除闭环**：删除 API 会等待活动索引并同步停止 watcher、清理数据和搜索缓存，旧后台任务不能复活已删除项目
- **Windows 自包含包**：ZIP 内置 Node.js 22、生产依赖和 `better-sqlite3` 原生二进制，无需 Node/npm/Visual Studio Build Tools
### v4.9.11
- **运行时数据健康诊断**：`/health` 和项目画像新增 `dataHealth`，区分 `ok`、`degraded`、`repairable`
- **坏状态可见**：注册项目目录丢失、项目列表读取失败、统计/向量/文件读取异常会返回明确检查项和建议，不再只表现为“服务活着但不好用”
- **修复建议闭环**：数据健康建议会提示检查项目路径、运行 `ace-mcp --doctor`、重新全量索引或预热向量索引
### v4.9.10
- **查询/任务模板**：Web 搜索和智能问答输入框下方新增常用模板按钮，减少重复输入
- **常用代码阅读任务**：内置“查调用链”“查影响面”“找潜在 bug”“补单元测试”“梳理业务流程”等模板
- **只填充不执行**：点击模板只写入对应输入框并聚焦，不自动发起搜索或问答，保留用户编辑空间
### v4.9.9
- **上下文包任务草稿**：Web 搜索结果摘要区和 QA 来源卡片的上下文包工具栏新增任务说明输入框
- **预设任务说明**：可一键填入“解释这段逻辑”“找潜在 bug”“生成修改方案”“补测试”，复制上下文包前仍可手动编辑
- **Agent 交接更明确**：复制上下文包、发送到 Codex、发送到 Claude 会把任务说明放在 Markdown 顶部，和已选代码片段一起交接
### v4.9.8
- **结果上下文打包**：Web 搜索结果摘要区和 QA 来源卡片可勾选多个结果，一次性复制 Markdown 上下文包
- **多文件交接**：上下文包包含项目根目录、绝对路径、`path:line` 引用、代码片段、命中原因、分数和 matched tokens
- **批量发送到 Agent**：新增“发送到 Codex / 发送到 Claude”批量按钮，只复制交接文本，不直接执行本机 CLI
### v4.9.7
- **IDE / Agent 定位闭环**：Web 搜索结果摘要区和 QA 来源卡片新增复制绝对路径、打开 VS Code、打开 IDEA、发送到 Codex、发送到 Claude
- **IDE 直达源码**：VS Code 使用 `vscode://file/...`，IDEA 使用 JetBrains deep link，结合当前项目根目录和结果行号直接打开命中文件
- **Agent 交接提示词**：Codex/Claude 操作复制包含项目根目录、绝对路径、相对引用和代码片段的提示词，不直接执行本机 CLI
### v4.9.6
- **懒加载上下文预览**：Web 搜索结果摘要区和 QA 来源卡片新增“更多上下文”，点击后按需调用 `/api/file-snippet` 读取命中行前后代码
- **metadata 模式可定位**：搜索结果不带 snippet 时仍能通过文件路径和行号加载更大上下文，不增加默认搜索响应体积
- **源码检查闭环**：复制路径/引用/片段后，可直接在页面内展开周边代码确认调用和条件分支
### v4.9.5
- **搜索结果可操作化**：Web 搜索结果摘要区和 QA 来源卡片提供复制路径、复制 `path:line` 引用和复制代码片段
- **metadata 模式可复制**：即使搜索结果不带 snippet，也能复制文件路径和引用，便于贴到 IDE、终端或 AI 对话里继续定位
- **命中解释批量控制**：搜索摘要区可一键展开或收起所有“为什么命中”标签，减少结果较多时的视觉噪音
### v4.9.4
- **搜索结果命中解释**：Web 搜索结果摘要区展示前 5 条结果的命中来源、关键词覆盖、路径/符号/片段命中和分数
- **来源卡片为什么命中**：问答参考代码卡片同步展示“为什么命中”标签，减少只看 JSON 才能判断召回原因的问题
- **metadata 模式可读性**：不改变排序和索引逻辑，仅复用已有 `reason`、`score`、`explanation` 元数据做轻量展示
### v4.9.3
- **画像修复结果可见化**：一键修复完成后在结果区展示任务状态、耗时和修复前后画像差异
- **失败文件明细面板**：`REVIEW_FAILED_FILES` 展示失败文件路径和错误信息，并提供复制路径按钮
- **修复确认闭环**：修复结果和原始 JSON 同步保留，便于确认索引、摘要和向量覆盖是否真正恢复
### v4.9.2
- **画像一键修复**：搜索画像的诊断建议直接提供按钮，点击即可提交对应修复动作
- **修复动作闭环**：`RUN_FULL_INDEX` 提交全量索引任务，`GENERATE_SUMMARY` 提交摘要任务，`WARM_VECTOR_INDEX` 调用向量预热，完成后自动刷新任务中心和搜索画像
- **失败文件查看**：`REVIEW_FAILED_FILES` 可直接展开最近索引失败文件，减少在 JSON 中查找问题的步骤
### v4.9.1
- **项目级搜索画像**：新增 `/api/project-profile`，一次性返回索引数量、语言分布、摘要状态、向量覆盖、最近索引事件和项目状态
- **召回诊断建议**：自动提示需要全量索引、生成摘要、预热向量、重建符号或检查失败文件，定位“为什么搜不到”的常见原因
- **Web 入口**：项目管理区新增“搜索画像”按钮，结果区直接展示画像卡片和诊断建议，同时保留原始 JSON 便于排查
### v4.8.10
- **Release secret guard**：新增 `npm run security:secrets` 和 `scripts/check-secrets.mjs`，检查环境变量 token 是否出现在项目文件、打包产物或 git history 中
- **发布门禁强化**：`release:check` 在生成 tgz/Windows zip 后自动运行 secret scan，防止产物里带入本地敏感值
- **安全输出**：secret scan 只输出 `redacted` 和位置，不会打印 token 内容
### v4.8.9
- **Gitee Release 自动发布**：新增 `npm run release:publish`，通过 `GITEE_TOKEN` 调用 Gitee OpenAPI 创建/更新 Release
- **附件幂等上传**：发布脚本会校验 git tag 与 tgz/Windows zip 产物，删除同名旧附件后重新上传，避免重复发版残留旧包
- **发布后自动验证**：上传完成后默认调用 `release:verify-assets`，确认 tag、tgz、Windows zip 与 macOS installer 下载链路可访问
### v4.8.8
- **安装发布闭环**：新增 `npm run release:verify-assets`，发布后校验 Gitee tag、tgz、Windows zip 与 macOS installer URL 可访问
- **固定 tag 安装脚本**：README 的 macOS 一键安装命令指向 `raw/v4.8.8/scripts/install-macos.sh`，避免 master 漂移影响历史版本安装
- **Release 检查清单增强**：发版 checklist 补充 asset verifier，确保复制安装命令前先验证真实下载链路
### v4.8.7
- **macOS 一键安装**：新增 `scripts/install-macos.sh`，支持一条 `curl` 命令下载 Gitee Release tgz 并全局安装
- **小白依赖清单**：README 补充 macOS 安装所需 Node.js、npm、curl、Homebrew、Xcode Command Line Tools 说明
- **安装后自检**：macOS 脚本安装完成后自动运行 `ace-mcp --doctor`，方便定位环境问题
### v4.8.6
- **重复任务复用**：同一项目、同一类型、同一索引 mode 的运行中任务会直接复用已有 `taskId`
- **任务取消**：新增 `POST /api/tasks/:taskId/cancel` 和 `canceled` 状态，任务中心可取消 running task
- **本地目录忽略**：仓库内 `/.ace-mcp`、`/.codex` 已加入 `.gitignore`，减少运行产物噪音
### v4.8.5
- **Web 任务中心**：页面右侧展示最近 index/summary 任务，包含项目、状态、耗时和开始/结束时间
- **任务过滤和详情**：支持按类型、状态和当前项目过滤，失败任务显示错误，成功任务可展开查看精简结果
- **任务 API 过滤**：`GET /api/tasks` 支持 `type`、`status`、`projectRootPath` 查询参数
### v4.8.4
- **索引任务异步化**：`POST /api/index-project` 快速返回 `202 + taskId`，full/incremental index 在后台执行
- **统一任务中心**：`/api/tasks` 同时展示 `index` 和 `summary` 任务的运行、成功、失败状态与结果
- **页面和维护脚本统一轮询**：Web 索引、添加项目、预加载和 `maintenance:reindex` 都改为提交任务后轮询完成
### v4.8.3
- **摘要生成异步化**：`POST /api/summary/generate` 快速返回 `202 + taskId`，索引刷新和 LLM 摘要生成都在后台执行
- **长任务 API**：新增 `/api/tasks` 和 `/api/tasks/:taskId`，可查询任务状态、耗时、成功结果或失败错误
- **脚本和页面轮询任务**：Web 生成摘要按钮与 `maintenance:reindex -- --summary` 都改为提交任务后轮询完成，不再持有分钟级 HTTP 请求
### v4.8.2
- **长任务状态可见**：`/health` 新增 `tasks`，摘要生成时展示项目路径、开始时间和已耗时，Web 状态条显示当前索引/摘要任务数
- **全量索引防误扫**：Web full index 对包含多个已登记子项目的父目录增加确认保护，避免误把 `/Users/.../code` 这类聚合目录当单项目重建
- **全库维护脚本**：新增 `npm run maintenance:reindex -- --dry-run|--summary`，按项目顺序 full index，可选生成摘要，自动跳过 missing 和聚合父目录并输出报告
### v4.8.1
- **Java Spring 入口更好搜**：提取 `@RequestMapping` / `@PostMapping` 等 mapping 注解路径，类级和方法级路径会合并成完整入口
- **接口方法能带出实现**：查询 `RefundService.submitRefund` 这类接口方法时，definition/callers 会同时覆盖实现类方法和上游 Controller 调用
- **字段注入调用可解析**：Java 字段类型参与调用解析，`refundService.submitRefund()` 能解析到接口方法，适合 Spring Service/Controller 项目
### v4.7.12
- **服务状态一眼可见**：Web 页头显示当前服务版本、watch 状态、项目就绪数量和最近索引时间，少一次手动健康检查
- **高级选项显示当前/最大**：搜索上下文、文件片段和 QA 数值选项都会显示当前值与最大值，点击“最大”或手动输入后同步更新
- **QA 参数回显**：每次问答完成后展示后端实际使用的参考代码数量、上下文预算、最大输出、超时、重试次数和上下文模式
### v4.7.11
- **代码片段上下文更大**：`includeContextLines` 共享上限从 200 提升到 500，Web 搜索上下文和 MCP/Web 请求校验保持一致，适合大文件定位时一次展开更多邻近代码
- **高级选项全部有最大值快捷按钮**：搜索结果数量、上下文行数、文件片段范围、QA 参考代码数量、上下文预算、LLM 最大输出、超时时间和失败重试次数都提供“最大”按钮
- **QA 重试实际生效**：Web 智能问答会把失败重试次数传给后端，非流式和流式 LLM 调用都会在开始输出前重试可恢复错误
- **静态契约覆盖**：新增 Web 静态契约断言，防止后续新增/调整 bounded numeric 控件时漏掉最大值快捷入口
### v4.7.10
- **Vue Options API 状态字段符号**：`.vue` 的 `props` object/array 形式和 `data()` 返回对象字段会作为组件内 `property` 符号索引，例如 `Navbar.currentLang`、`Pagination.total`
- **模板状态引用闭环**：模板中的 `v-model="currentLang"`、`:total="total"`、`{{ hidden }}` 等 ownerless usage 可解析回 `props/data` 定义，同时不会出现在 `find_callers`
- **真实 Vue 2 项目验证**：`tc-flight-endorse-mng` 315 个文件索引成功，`Navbar.currentLang`、`Pagination.total`、`Pagination.hidden` 均可查定义与模板引用
### v4.7.9
- **Vue Options API 符号提取**：`.vue` 的 `export default { methods/computed/watch }` 成员和常见生命周期函数会作为组件内 `method` 符号索引，例如 `EndorseLookup.search`、`Navbar.changeLanguage`
- **模板引用闭环**：模板中的 `@click="search"`、`@change="changeLanguage"` 等 ownerless usage 现在能稳定解析回 Options API 方法定义，同时仍不会把模板行注入 `find_callers`
- **真实 Vue 2 项目验证**：`tc-flight-endorse-mng` 315 个文件索引成功，`src/views/endorse-lookup/index.vue` 的 `search` 和 `src/layout/components/Navbar.vue` 的 `changeLanguage` 均可查定义与模板引用
### v4.7.8
- **搜索上下文上限提升**：`includeContextLines` 共享上限从 50 提升到 200，MCP schema 和 Web 请求钳制保持一致，搜索结果可一次展开更大的命中邻近代码窗口
- **Web 最大快捷按钮**：搜索上下文行数、文件片段结束行、智能问答参考代码数量和上下文 token 预算都新增“最大”按钮，减少手动输入
- **QA 上下文预算直连**：Web 智能问答高级选项新增 `maxContextTokens` 输入，SSE 请求会把按请求预算传给后端，默认 48000、最大 200000
### v4.7.7
- **Vue 模板引用提取**：`.vue` 的 `<template>` 中组件标签、`@event` / `:prop` / `v-*` 指令表达式和 `{{ interpolation }}` 会作为 ownerless `usage` 写入，用于 `find_references` 与 RAG 召回
- **Svelte markup 引用提取**：`.svelte` 的 markup 组件标签、`on:` / `bind:` / 普通 `{expression}` 和 `{#if}` 等块表达式会作为 usage 索引，并保留原始组件行号
- **调用图噪音控制**：模板 usage 不设置 `ownerSymbol`，因此能被 reference 检索召回，但不会把模板行误注入 `find_callers`；真实 Vue 项目 `tc-flight-endorse-mng` 已验证模板事件引用可召回且 callers 不污染
### v4.7.6
- **Vue/Svelte SFC 脚本索引**：`.vue` / `.svelte` 文件会被收集为 JavaScript 语言文件，仅抽取 `<script>` / `<script setup>` 内容交给现有 TS/JS AST adapter 分析
- **原始行号映射**：SFC 脚本分析使用等长虚拟源码，symbols/imports/usages 的行号仍指向原始组件文件，源码跳转和调用图位置不偏移
- **调用图联通**：SFC 内 import、实例化和方法调用参与既有 JS/TS resolver，支持从普通 `.ts` 定义反查 Vue/Svelte 组件 caller
### v4.7.5
- **Markdown section 符号**：`#`~`######` 标题会被索引为 `section`，支持 `symbol:` 搜索和 `find_definition` 查文档章节，层级标题保留父级和文档路径信息
- **文档示例反向引用**：fenced code block 内的代码标识符会作为 `usage` 写入，`find_references` 查询代码符号时能召回引用该符号的 Markdown 示例
- **噪音控制**：代码块内的 Markdown 样式文本不会被误识别为 heading，dotted 调用只记录一条 usage，且 Markdown usage 不绑定 owner symbol，避免污染调用图 caller
### v4.7.4
- **JS/TS 导出实例类型传播**：`export const service = new Service()` 被其他文件 `import { service }` 后，`service.method()` 现在会优先解析到 `Service.method`，而不是同模块里第一个同名方法
- **JavaScript 限定的解析增强**：内部导出值类型候选只由 JS/TS AST adapter 产生，SQLite resolve 阶段也只在 `language === "javascript"` 的 import alias 上消费，避免改变 Java、Python、.NET、Markdown 查询路径
- **回归测试**：新增 JS/TS exported instance 调用链测试，并保留 Python variable type inference guard，覆盖目标修复和非 JS 语言查询不回退
### v4.7.3
- **索引去重可观测性**：同项目索引运行期间的重复请求继续复用 in-flight Promise，并在 `/health` 的 `indexing` 条目中暴露 `status`、`queuedRequests` 和 `dedupedRequests`
- **队列清理稳定性**：复用 in-flight 索引的 timeout 会在 Promise 完成后清理，队列清理链路吞掉已处理错误，避免失败索引在测试或一次性命令中留下 unhandled rejection
- **回归测试**：新增 `IndexCoordinator` 重复请求测试和 Web health shape 断言，覆盖同项目 dedupe 计数与健康检查输出
### v4.7.2
- **Health 响应性**：`/health` 不再逐项目调用 `getProjectStats` 做同步 SQLite 统计，避免后台索引或写锁期间健康检查被拖到数秒甚至超时
- **轻量运行态指标**：健康检查保留运行时、watch、项目数量、in-flight indexing 与向量配置，并从项目列表字段推导 `latestIndexAt`；深度文件/chunk/symbol 统计继续通过项目详情接口读取
- **回归测试**：新增 Web 回归测试模拟慢速 per-project stats，验证 `/health` 不等待该路径，focused 测试从 252ms 降到约 8ms
### v4.7.1
- **搜索 benchmark 工具**：新增 `npm run benchmark:search`，可对已索引项目输出 search p95、health p95 和事件循环响应性；`npm run release:benchmark` 提供隔离 smoke，当前 release check 结果为 resultCount 1、search p95 78ms、health p95 12ms、event-loop responsive 1/1
- **SQLite 连接稳定性**：SQLite store 构造阶段统一设置 WAL、`busy_timeout=30000`、`synchronous=NORMAL` 等连接级 PRAGMA，搜索 worker 的独立连接也会应用同样的锁等待策略，降低并发索引/搜索时 `database is locked` 的概率
- **发布诊断增强**：benchmark smoke 隔离 HOME、关闭一次性服务的 auto-watch，并在失败时输出子进程 stdout/stderr 与 `.ace-mcp/log`，便于定位 release 阶段崩溃
### v4.7.0
- **SQLite 搜索 worker**：`search_context` 普通/结构化查询中的 lexical、semantic FTS、unicode substring、symbol、path 和文件预览读取改由独立 SQLite 搜索 worker 执行，避免 `better-sqlite3` 同步大查询占住 Web/MCP 主事件循环
- **源码测试兼容**：dist 使用 `worker_thread`，源码/dev/test 运行时使用 `node --import tsx` IPC 子进程执行同一 worker 入口，保证开发环境和发布包都走异步搜索读路径
- **并发回归测试**：新增 `searchServiceConcurrency.test.ts`，证明 SQLite 搜索 pending 时 `setTimeout(0)` 能先于搜索 Promise 完成被调度
### v4.6.9
- **安装自检（`--doctor`）**：新增本地健康检查，覆盖 Node/npm、`better-sqlite3`、SQLite FTS5、数据/日志/配置目录写权限、Web 端口占用与 LLM/Embedding 配置，输出明确修复建议
- **安装包 smoke test**：新增 `npm run release:smoke`，从当前 tgz 安装到临时目录，验证 `ace-mcp --version`、`ace-mcp --doctor`、`ace-mcp-web` 与 `/health`
- **Windows 安装闭环**：zip 安装脚本在 `npm install --omit=dev` 后自动运行 `node dist\index.js --doctor`，更早暴露原生依赖和环境问题
### v4.6.8
- **Windows zip 打包**：新增 `npm run release:win`，构建后生成 `release/ace-mcp-v4.6.8-win-x64.zip`，包含 `dist/`、生产依赖安装入口、README、许可证与启动脚本
- **Windows 安装脚本**：新增 `install.cmd` / `install.ps1` 包装入口及 `scripts/install-windows.{cmd,ps1}`，检查 Node/npm 版本并执行 `npm install --omit=dev`，失败时提示 `better-sqlite3` 与 Visual Studio Build Tools 处理方式
- **Windows 专用 README + 发布清单**：补充 zip/npm/tgz 全局安装、`ace-mcp.cmd` MCP 路径、`ExecutionPolicy` 说明，并新增 `docs/release-checklist.md` 固化发版验证步骤
### v4.6.7
- **npm/tgz 全局安装**：包从私有项目改为可发布包，新增 `ace-mcp-web` 全局命令，`npm install -g ace-mcp` 或 `npm install -g ./ace-mcp-4.6.7.tgz` 后可直接启动 Web 面板
- **Windows 启动脚本**：新增 `scripts/start-web.cmd` 与 `scripts/start-web.ps1`，支持默认 8787 端口、位置参数端口和 `ACE_MCP_WEB_PORT`
- **发布打包脚本**：新增 `npm run release:pack`，打包时包含 `scripts/`，并继续排除 `dist/**/*.test.*` 与 `dist/test/**`
### v4.6.6
- **补齐质量防线**：恢复 `npm test` 的真实可执行性，补齐脚本中引用但仓库缺失的 17 个测试文件，覆盖 CLI、查询分析、端到端索引/搜索、Web `/health` 与参数校验、SQLite/VectorCache、搜索打分/辅助函数、语义文本、远程 Embedding fallback、QA 缓存、共享 schema、源码解码、IndexCoordinator freshness 与 evalRunner。当前仓库 `npm test` 跑 50 个用例全绿
- **中文复杂问题 source 估算修复**：`estimateOptimalSources` 先判断复杂/Review 意图，再走短查询兜底，避免中文无空格问题因 `wordCount <= 3` 被误判为简单查询，只给 5 个参考源
- **中文源码解码评分修复**：`decodeSourceBuffer` 评分对可读 CJK 字符加权，GBK 中文源码不再被 latin1 乱码误判
### v4.6.5
- **修复暖机窗口内索引元数据失真**：v4.6.4 暖机用硬编码 `vectorIndex.enabled=false`、全零 `timings`/计数的合成结果恢复 freshness 状态，导致暖机窗口内（`stale` 默认 30s，`manual` 则无限期）所有工具/Web 响应把向量索引误报为禁用。改为铺展真实的 `latestIndexEvent`，仅 `null` 时回退默认值；不改动跳描行为，仅修正上报元数据
### v4.6.4
- **冷启动暖机（`--warm`）**：新增 `--warm` CLI 标志，服务启动后异步暖机已索引项目，消除重启后首次查询 18-22s 延迟。三层暖机策略：① 从数据库恢复 `ensureFreshIndex` 内存状态使 `"stale"` 策略跳过已知最新项目；② 预加载向量缓存 + 触发异步 HNSW 构建；③ 确保 `semantic FTS` 索引完整。暖机完全异步、不阻塞 MCP/Web 可用性
### v4.6.3
- **修复 PNG 导出失败**：mermaid flowchart 默认 `htmlLabels:true` 用 `<foreignObject>` 渲染文字，导致含 foreignObject 的 SVG 光栅化到 canvas 被污染、`toBlob` 抛错。改 `flowchart:{htmlLabels:false}` 用纯 `<text>` 渲染（外观无退化），并将 PNG 加载改为 data URL。已用真实 Chrome 验证 PNG 正常导出
### v4.6.2
- **流程图导出**：业务流程图与调用链图渲染后均提供导出工具栏——下载 PNG（SVG→canvas 光栅化、白底、×2 清晰度）、下载 SVG（矢量无损）、复制 Mermaid 源码（可粘到其他编辑器）。纯前端，不动后端
### v4.6.1
- **业务流程图**：智能问答分析完业务逻辑后，答案末尾自动追加「业务流程图」一节（`flowchart TD`），把关键步骤/判断可视化。仅改一处 `QA_SYSTEM_PROMPT` 覆盖 MCP/Web/SSE 三条路径；前端 `renderMarkdown` 先抽取 ```` ```mermaid ```` 块再走其余变换（避免被引用正则/段落变换破坏），流式结束后 `mermaid.run()` 渲染为 SVG，失败回退保留原文代码块
- **自动化质量防线（`--eval`）**：新增 `--eval <caseFile>` CLI 与 `npm run eval`，加载 JSON golden 用例、逐 suite 跑 `evaluateSearchQuality`、打印 PASS/FAIL + passRate/top1/top5/MRR，按 `minPassRate`（默认 1.0）以退出码 0/1 判定，可纳入发版前回归。提交脱敏模板 `example/eval-cases.example.json`；真实业务用例放 `eval-cases/`（已 gitignore）
### v4.6.0
- **SSE 断连中止上游 LLM（#39）**：客户端断连后通过 `AbortController` 真正中止上游 LLM 请求，不再白烧 token；LLM 阶段前增加断连早退
- **引用跳转容错**：前端正则容错 LLM 偶发输出的 `[1:L60-L88]` 形式引用（此前显示为死文本），并在提示词中明确只用纯 `[N]`
- **cosineSimilarity 合一（#34）**、**缓存淘汰 FIFO 化（#35，remoteEmbedding/searchService 两处 O(n log n) 排序消除）**、**Error/AppError 统一（#38，llmClient/summaryGenerator 六处，Web 出口不再一律 500）**
### v4.5.15
- **打分恰好一次（#23）**：搜索排序管线此前对同一结果重复打分并写回（碰撞结果 bonus 累加 3 次、无碰撞 2 次），排序被路径依赖扭曲。现 `choosePreferredResult` 仅比较不写回、`rerankResults` 删除二次打分，bonus 恰好加一次。实测业务逻辑类排位上升、枚举/常量类下降
- **CJK 语义 FTS 词数上限（#37）**：`buildSemanticFtsQuery` 截断改为 CJK 感知——含中文上限 15（配合 v4.5.13 bigram 分词），纯 ASCII 维持 8。中文查询 semantic 候选 15→18
### v4.5.14
- **ask_codebase reranker 对齐**：MCP `ask_codebase` 此前硬编码强制开启 LLM reranker（覆盖全局默认 `enableLlmReranker=false`），每次问答多付 ~10s reranker 调用。现回落配置默认，并新增可选 `enableReranker` 参数按请求覆盖。附 #42 重测结论：v4.5.13 后 QA 的 expansion/search 已降至几百 ms，剩余耗时主体为 LLM 端点生成速度（属配置/选型，可换更快模型或调低 `llmMaxTokens`/`maxSources`）
### v4.5.13
- **中文查询分词**：中文自然语言问题此前被切成一个整串 token（CJK 属字母、中文无空格），`queryAnalyzer` 新增 CJK bigram 切分（复用 `buildCjkBigrams`）：整串保留以保精确匹配，并追加 bigram（上界 16）
- **语义索引存在性检查性能修复（关键）**：`ensureSemanticIndex` 每次语义搜索都跑，此前用 `LEFT JOIN` FTS5 未索引列判断缺失 chunk，退化为 O(n²) 逐行扫 FTS，2k chunk 项目实测每次查询白跑 ~122s。改为 `NOT IN` 单次 O(n) 扫描（122s→1.2s）。中文问答端到端实测 **~64s → ~1.8s**
### v4.5.12
- **放开参考代码量**：对大接口提问时参考代码不够用（受 `qaMaxContextTokens` 默认 24000 限制，超出即被 `compressContext` 截断）。默认上下文预算提高到 48000、`qaMaxSourcesDefault` 提到 15；`ask_codebase` 与 Web `/api/qa/ask`（含 SSE）新增可选 `maxContextTokens` 按请求覆盖，受新增上限 `qaMaxContextTokensMax`（默认 200000）钳制。最终量仍受 LLM 上下文窗口约束
### v4.5.11
- **QA 上游使用方（caller）扩展**：智能问答对「X 场景有什么特殊处理」这类问题，此前只召回定义符号的 model/enum/VO 定义类，真正使用该符号做业务判断的逻辑类（caller）从未进入上下文。新增 `findUpstreamUsages`，从召回结果片段中提取已定义符号（getter/方法名），查它们的 `findCallers`，把使用方业务类源码（含调用点 ±15 行）拉进问答 context；对 service/logic/processor/handler/impl 等业务层 caller 加权、限量去噪。对称补齐 v4.4.8 的下游（callee）扩展，纯本地调用图查询，不增加 LLM 调用、不改通用打分
### v4.5.10
- **searchByPath 文件名匹配度排序**：路径搜索多取候选后按 basename 匹配度（去扩展名精确>精确>前缀>包含>仅目录）重排再截断，文件名精确匹配不再因路径长被截掉；评分逻辑不变
- **日志统一**：`RemoteEmbeddingProvider` 的 `console.warn` 改为注入的 `logger?.warn`，避免 MCP stdio 模式下污染 stdout
### v4.5.9
- **Web API 验证统一**：新增 `core/validation/schemas.ts` 作为入参枚举/边界/默认值的单一来源，MCP 工具与 Web 路由共用；Web 侧保持宽松（coerce+clamp），仅必填项缺失时返回 400。修正 `qa/ask` 的 `contextMode` 默认值与 MCP/SSE 对齐
- **关键路径测试覆盖**：测试 33→97，新增 9 个测试文件覆盖 `safeJsonParse`、搜索打分/工具纯函数、`QaCache`、共享/宽松校验、`VectorCacheStore` reconcile、`deleteFiles` 级联、源码解码助手
### v4.5.8
- **JSON.parse 防护**：数据库列解析新增 `safeJsonParse` 工具（6 处），列损坏时降级为空值并记日志，不再崩溃进程
- **大文件中等拆分**：公共 API 与现有测试不变的前提下，`sqliteStore.ts`（2879→2004，抽出 `VectorCacheStore`/types/helpers）、`app.ts`（1532→50，路由拆到 `web/routes/*`）、`searchService.ts`（1765→1073，纯函数拆到 `searchScoring.ts`/`searchHelpers.ts`）拆为聚焦模块
### v4.5.7
- **增量索引 vector 缓存精准失效**：增量索引后不再整体清空向量缓存，而是只移除受影响文件的向量、重查其当前向量并同步 `index_version`（`reconcileVectorCacheAfterIndex`）。改几个文件不再触发 10 万向量全量重载；HNSW 标记 stale 后按需异步重建，重建期间走暴力搜索保证结果正确。`deleteFiles`/`writeChunkVectors` 改为按路径/按 chunk 精准更新缓存
### v4.5.6
- **HNSW 构建分批 yield**：`addBatchAsync` 每 500 节点让出事件循环，避免大型项目冷启动阻塞数十秒
- **CJK 单字 token 搜索**：修复纯 CJK 单 token 被误判为 symbol-like 导致 semantic 召回被关闭的问题，中文查询恢复 bigram 前缀匹配
- **symbol full_name 函数索引**：新增 `idx_symbol_full_name_lower`，加速符号解析等值匹配
### v4.5.5
- **多源分数归一化**：`mergeResults` 合并前对每个搜索源（lexical/symbol/semantic/path）的分数做 min-max 归一化至 [0,1]，消除不同源分数量级差异导致的排序偏差
- **Java Lambda/方法引用解析**：Java 适配器新增 Lambda 表达式（`x -> foo(x)`）和方法引用（`Foo::bar`、`this::process`）的调用关系提取，调用链分析可追踪函数式调用路径
- **HNSW 二进制序列化**：HNSW 索引磁盘存储从 JSON 替换为紧凑二进制格式（Float32 向量 + 变长 ID），体积缩小约 5 倍，加载速度提升 3-10 倍；向后兼容自动识别旧 JSON 格式
### v4.5.4
- **vectorCache 内存控制**：HNSW 可用时释放 vectors 数组，省 600MB/10 项目
- **FTS 删除批量化**：逐条 DELETE → WHERE IN 批量删除
- **readFileSnippet LRU 缓存**：200 条上限 + mtime 失效，避免重复全量读取
- **callChain 同层并行**：callers/callees Promise.all 并行提取
- **符号解析消歧**：同文件/同模块优先排序，减少同名方法误解析
### v4.5.3
- **代码标识符优先搜索策略**：当查询同时包含代码标识符（camelCase/snake_case/PascalCase）和自然语言（中文/英文）时，新增标识符优先搜索轮次。纯标识符 FTS 搜索结果获得 0.5× 分数加成，使目标 Controller/Service 在混合查询中排名显著提升
- **上下文截断居中**：`compressContext` 截断逻辑从"从文件头开始截断"改为"以匹配行范围为中心截断"，确保大文件中目标方法始终在 LLM 上下文中可见
### v4.5.0
- **QA 上下文完整性修复**：下游搜索结果片段从索引原始大小（~1-3 行）展开至 ±15 行上下文，方法体实现正式可读。调用链片段截断限制从 200 提升至 600 字符。新增 `extractTypeReferencesFromSnippet`，从源码提取 PascalCase 类型引用（DTO/VO/Param 等），自动发现并注入 DTO 定义文件。
### v4.4.9
### v4.4.8
### v4.4.7
- **FTS 中文噪声过滤**：查询中包含代码标识符（camelCase/PascalCase）时，FTS 搜索自动排除 CJK 噪声词条，避免中文自然语言词条（如"接口"、"逻辑"）稀释 bm25 排序分数导致目标代码排名下降
- **覆盖率评分优化**：含代码标识符的非路径查询中，token 覆盖率计算排除 CJK token，确保标识符精确匹配获得应有的评分权重
### v4.4.6
- **QA 管线并行化**：查询扩展与 Round1 搜索并行执行（`Promise.all`），减少串行等待；Reranker 增加 10s 超时保护，避免无限阻塞；查询扩展结果缓存（100 条 LRU，5 分钟 TTL），相同问题不重复调用 LLM
- **向量搜索冷启动优化**：HNSW 索引磁盘读写改为异步（`fs.promises`），不阻塞主线程；首次加载返回空索引立即可用，后台异步构建 HNSW
- **调用链提取并行化**：多符号调用链查询从串行改为并行（`Promise.all`），递归深度展开同层也并行处理
- **SQL 查询优化**：新增 `LOWER(name)` 表达式索引加速符号模糊搜索；文本搜索用 FTS5 预过滤替代全表 `instr()` 扫描；3 处关联子查询改为 `LEFT JOIN` 减少重复查询
### v4.4.5
- **LLM 最大输出 token 可配置**：智能问答高级选项新增 `maxTokens` 配置（默认 8192，范围 512~32768），用户可自行调整 LLM 回答的最大 token 数。此前默认 2048，结合本地代码后回答经常被截断
- **`llmMaxTokens` 默认值从 2048 提升到 8192**：确保回答不会被截断
### v4.4.4
- **"结合本地代码"开关**：智能问答高级选项新增 checkbox，控制是否读取搜索命中文件的完整本地源码。开启时使用 `full-file` 模式，LLM 能看到完整实现逻辑，更准确但消耗更多 token；关闭时使用 `chunk` 模式，更快更省 token。默认开启
### v4.4.3
- **调用链源码补全**：QA 管线在提取调用链关系后，自动读取每个 caller/callee 的源码（上下文 ±5 行），作为独立 section 注入 LLM 上下文。此前调用链只返回符号名和位置，LLM 无法理解具体实现逻辑
- **去重机制**：调用链源码与搜索结果按 `filePath:startLine` 去重，避免重复注入相同代码
- **`qaMaxContextTokens` 从 12000 提升到 24000**：token 预算翻倍确保搜索结果和调用链源码都能完整注入
- **`qaMaxSourcesMax` 从 50 提升到 100**：支持更多参考代码片段
### v4.4.2
- **HNSW 向量搜索**：纯 JS 实现 HNSW 近似最近邻索引，搜索复杂度从 O(n) 降到 O(log n)，大型项目性能显著提升
- **调用链深度增强**：支持 1-3 跳调用关系追踪，递归展开上下游调用链
- **Web 质量评估界面**：新增搜索质量评估面板，支持测试用例管理、批量评估、指标可视化
### v4.4.0
- **符号级语义索引**：索引阶段自动为英文符号名生成中文语义标签（200+ 词汇表翻译），写入 `chunk_semantic_fts`，使 FTS 天然支持中文搜索匹配英文代码
- **双轮搜索策略**：QA 问答先用原始查询搜索（受益于语义标签），再用 LLM 扩展的英文关键词补充搜索，两轮结果合并去重
- **中英文同义词扩充**：70+ 组中英文双向同义词映射，中文查询"出票"自动扩展匹配 "ticket"
### v4.3.9
- **LLM 查询扩展**：中文自然语言查询自动提取英文代码关键词（类名、方法名），解决跨语言搜索匹配问题
- **索引超时保护**：`ensureFreshIndex` 和 in-flight promise 复用均添加超时，避免卡住的索引阻塞搜索
- **projectQueue 清理 bug 修复**：修复等式比较永远为 false 导致的队列泄漏
### v4.3.8
- **全文件/合并文件上下文模式**：`ask_codebase` 支持 `contextMode` 参数，解决跨函数问答信息缺失
- **统一 QA 管线**：MCP `ask_codebase` 与 Web QA 共用完整管线（reranker、调用链、缓存、smart topK）
- **搜索 Reranker 通用化**：MCP `search_context` 新增 `enableReranker` 参数
- **动态 perFileLimit**：根据查询类型自动调整每文件结果数
### v4.3.0
- **智能 Sources 数量**：根据问题复杂度自动调整检索源数量
- **LLM 响应缓存**：相同问题 5 分钟内直接返回缓存结果
- **思考过程展示**：DeepSeek reasoning_content 实时显示
### v4.2.x
- **流式问答**：SSE 逐 token 输出
- **多轮对话**：支持上下文追问
- **代码引用高亮**：`[N]` 引用可点击跳转
- **中文界面**：全新设计的中文 Web 面板
- **搜索结果懒加载**：代码 snippet 折叠显示
- **错误分类展示**：区分网络/超时/LLM/索引错误
- **Token 统计**：会话级 token 累计统计
### v4.0.x
- **代码知识库**：摘要生成、语义问答 RAG、文档联合索引
- **LLM API 集成**：支持 OpenAI 兼容接口
### v3.x
- **语言级符号解析**：definition/reference、调用关系图
- **结构化查询**：布尔运算和字段限定
- **向量搜索**：语义召回、候选预过滤
- **索引优化**：新鲜度策略、缓存管理
## 路线图
详见 [ROADMAP.md](./ROADMAP.md)
## 开发建议
如果继续增强，建议按以下顺序推进：
1. 更丰富的 Web 结果分析、质量回放与对比界面
2. 更深的调用关系与引用精度
3. 更细的语言适配器拆分
This server cannot be deployed
Maintenance
ActivityMaintained
ResponsivenessUnresponsive