ace-tool-windows 0.1.3 → 0.1.5

package/README.md

@@ -1,62 +1,28 @@
 # ace-tool-windows
 
-Rust + Win32 的 MCP Server（stdio），提供 `search_context` 与 `enhance_prompt`，并用原生 Win32 GUI 替代浏览器交互。
+Rust + Win32 的 MCP Server（stdio），提供 `search_context` 与 `enhance_prompt`，用原生 Win32 GUI 替代浏览器交互。
 
 > 原项目：https://github.com/eastxiaodong/ace-tool
 
-## 目录
-
-- 项目简介
-- 功能特性
-- 环境要求
-- 快速开始
-- 配置为 MCP Server
-- 从源码运行
-- MCP 工具说明
-- 配置说明
-- npm 打包与发布
-- 项目结构
-- 对齐清单（Node 版本）
-- 测试
-- License
-- 致谢
-
-## 项目简介
-
-本仓库是 ace-tool 的 Rust + Win32 重写版本，目标与 Node 版本功能 1:1 对齐，同时保持 MCP stdio 兼容，供 Codex 客户端调用。
-
-## 功能特性
-
-- MCP JSON-RPC over stdio，支持工具列举与调用
-- `search_context`：索引 + 检索代码库上下文
-- `enhance_prompt`：调用远端增强服务，支持中文/英文自动判断
-- Win32 GUI 交互窗口，提供继续增强 / 使用原始 / 结束对话
-- 本地索引与日志输出（`.ace-tool/`）
-
-## 环境要求
-
-- Windows 10/11（Win32 GUI）
-- Rust 工具链（建议稳定版）
-- Node.js + npm（用于发布到 npm）
-
 ## 快速开始
 
-全局安装后使用：
+### 1) 安装
 
 ```powershell
 npm i -g ace-tool-windows
-ace-tool-win --base-url <URL> --token <TOKEN> [--enable-log]
 ```
 
-## 配置为 MCP Server
+### 2) 直接运行（本地验证）
 
-本项目是 MCP stdio Server。配置时只需要声明 command + args，不需要额外端口配置。
+```powershell
+ace-tool-win --base-url <URL> --token <TOKEN> [--enable-log]
+```
 
-说明：不同 MCP 客户端字段名可能是 `mcpServers` 或 `servers`，以客户端文档为准。下面给出两种常见 JSON 格式。
+### 3) 配置为 MCP Server
 
-### 方式一：mcpServers 格式（常见）
+> 不同 MCP 客户端字段名可能是 `mcpServers` 或 `servers`，以客户端文档为准。
 
-使用 npm 全局命令：
+**mcpServers 格式（常见）**
 
 ```json
 {
@@ -69,20 +35,20 @@ ace-tool-win --base-url <URL> --token <TOKEN> [--enable-log]
 }
 ```
 
-使用本地 exe 路径：
+**使用本地 exe 路径**
 
 ```json
 {
   "mcpServers": {
     "ace-tool-windows": {
-      "command": "C:\\\\path\\\\to\\\\ace-tool-win.exe",
+      "command": "C:\\path\\to\\ace-tool-win.exe",
       "args": ["--base-url", "<URL>", "--token", "<TOKEN>"]
     }
   }
 }
 ```
 
-### 方式二：JSON 模式（servers 格式）
+**servers 格式（兼容模式）**
 
 ```json
 {
@@ -95,20 +61,47 @@ ace-tool-win --base-url <URL> --token <TOKEN> [--enable-log]
 }
 ```
 
-### 参数说明
+配置完成后，在 AI CLI 中输入 `xxxxx -enhance` 即可触发 `enhance_prompt`（同样支持 `-enhancer`）。
+
+## 项目简介
+
+本仓库是 ace-tool 的 Rust + Win32 重写版本，目标与 Node 版本功能 1:1 对齐，同时保持 MCP stdio 兼容，供 Codex / MCP 客户端调用。
+
+## 功能特性
+
+- MCP JSON-RPC over stdio，支持工具列举与调用
+- `search_context`：索引 + 检索代码库上下文
+- `enhance_prompt`：调用远端增强服务，支持中文/英文自动判断
+- Win32 GUI 交互窗口，提供继续增强 / 使用原始 / 结束对话
+- 本地索引与日志输出（`.ace-tool/`）
+
+## 环境要求
+
+- Windows 10/11（Win32 GUI）
+- Rust 工具链（建议稳定版）
+- Node.js + npm（用于发布到 npm）
+
+## 配置说明
+
+### CLI 参数
 
 - `--base-url` 必填，服务地址；未写协议会自动补 `https://`
 - `--token` 必填，ACE 服务 Token
 - `--enable-log` 可选，写入 `.ace-tool/ace-tool.log`
 
-> 提示：`enhance_prompt` 会弹 Win32 窗口确认；如果只想后台检索，可只调用 `search_context`。
-
-## 从源码运行
+### 环境变量（可选）
 
-```powershell
-# 在仓库根目录
-cargo run -- --base-url <URL> --token <TOKEN> [--enable-log]
-```
+- `ACE_TOOL_HEADLESS=1`：跳过 UI，直接返回增强结果
+- `ACE_TOOL_HEADLESS_ACTION=enhanced|end|timeout`：headless 模式返回策略，默认 enhanced
+- `ACE_TOOL_DEBUG=1`：输出 MCP 调试日志（stderr + 文件）
+- `ACE_TOOL_DEBUG_VERBOSE=1`：输出更详细的帧解析日志
+- `ACE_TOOL_DEBUG_FILE=<path>`：调试日志路径，默认 `%TEMP%\\ace-tool-mcp.log`
+
+### 超时规则（重要）
+
+- 本项目默认不提供自定义超时参数。
+- MCP 调用超时以客户端（Codex）配置为准，例如 `tool_timeout_sec` / `startup_timeout_sec`。
+- 如需调整，请在 Codex 客户端配置中修改，不建议在服务端再做一套超时逻辑。
 
 ## MCP 工具说明
 
@@ -124,24 +117,15 @@ cargo run -- --base-url <URL> --token <TOKEN> [--enable-log]
 - 语言检测：中文输入 -> 中文输出；英文输入 -> 英文输出
 - 工具名映射：`codebase-retrieval` -> `search_context`
 - 8 分钟超时回退到原始 prompt
+- 默认弹 Win32 窗口，等待用户点击后返回
+- 如需无 UI，可设置 `ACE_TOOL_HEADLESS=1`
 
-## 配置说明
-
-必填参数：
-- `--base-url`
-- `--token`
-
-可选参数：
-- `--enable-log`（写入 `.ace-tool/ace-tool.log`）
-
-### 认证 URL 与 Token 获取
-
-认证服务的 URL 与 Token 获取方式以原项目说明为准，建议先阅读原项目文档与相关讨论：
-
-- 原项目仓库：https://github.com/eastxiaodong/ace-tool
-- Issue #6: baseUrl 和 Token 有办法获取吗？
+## 从源码运行
 
-注意：Issue #6 中有用户提到 baseUrl 直接指向 augmentcode.com，但未给出 Token 的官方获取流程，请以服务提供方的最新说明为准。
+```powershell
+# 在仓库根目录
+cargo run -- --base-url <URL> --token <TOKEN> [--enable-log]
+```
 
 ## npm 打包与发布
 
@@ -165,7 +149,7 @@ npm publish --access public
 
 ## 项目结构
 
-```
+```text
 ace-tool-windows/
 - Cargo.toml
 - package.json
@@ -254,7 +238,3 @@ Apache-2.0
 ## 致谢
 
 - 原项目：ace-tool（https://github.com/eastxiaodong/ace-tool）
-
-
-
-

package/package.json

@@ -1,43 +1,39 @@
-{
-  "name": "ace-tool-windows",
-  "version": "0.1.3",
-  "description": "ACE MCP server for Windows (Win32)",
-  "bin": {
-    "ace-tool-win": "bin/ace-tool-win.js"
-  },
-  "os": [
-    "win32"
-  ],
-  "cpu": [
-    "x64"
-  ],
-  "files": [
-    "bin/ace-tool-win.js",
-    "bin/ace-tool-win.exe",
-    "README.md",
-    "LICENSE"
-  ],
-  "license": "Apache-2.0",
-  "scripts": {
-    "build:bin": "powershell -NoProfile -ExecutionPolicy Bypass -File scripts/build-bin.ps1",
-    "pack:local": "npm run build:bin && npm pack",
-    "publish:public": "npm run build:bin && npm publish --access public"
-  },
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/doudouHubs/ace-tool-windows.git"
-  },
-  "bugs": {
-    "url": "https://github.com/doudouHubs/ace-tool-windows/issues"
-  },
-  "homepage": "https://github.com/doudouHubs/ace-tool-windows#readme",
-  "keywords": [
-    "mcp",
-    "ace-tool",
-    "win32",
-    "windows"
-  ]
-}
+{
+  "name": "ace-tool-windows",
+  "version": "0.1.5",
+  "description": "ACE MCP server for Windows (Win32)",
+  "bin": {
+    "ace-tool-win": "bin/ace-tool-win.exe"
+  },
+  "os": [
+    "win32"
+  ],
+  "cpu": [
+    "x64"
+  ],
+  "files": [
+    "bin/ace-tool-win.exe",
+    "README.md",
+    "LICENSE"
+  ],
+  "license": "Apache-2.0",
+  "scripts": {
+    "release": "cargo build --release",
+    "build:bin": "powershell -NoProfile -ExecutionPolicy Bypass -File scripts/build-bin.ps1",
+    "pack:local": "npm run build:bin && npm pack"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doudouHubs/ace-tool-windows.git"
+  },
+  "bugs": {
+    "url": "https://github.com/doudouHubs/ace-tool-windows/issues"
+  },
+  "homepage": "https://github.com/doudouHubs/ace-tool-windows#readme",
+  "keywords": [
+    "mcp",
+    "ace-tool",
+    "win32",
+    "windows"
+  ]
+}

package/bin/ace-tool-win.js

@@ -1,237 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const { spawn } = require('child_process');
-
-const DEFAULT_PROTOCOL_VERSION = '2024-11-05';
-const SUPPORTED_PROTOCOL_VERSIONS = new Set([
-  'DRAFT-2026-v1',
-  '2025-06-18',
-  '2025-03-26',
-  '2024-11-05',
-  '2024-10-07',
-]);
-
-function logError(message) {
-  process.stderr.write(`${message}\n`);
-}
-
-const backendExe = process.env.ACE_TOOL_WIN_EXE || path.join(__dirname, 'ace-tool-win.exe');
-if (!fs.existsSync(backendExe)) {
-  logError(`ace-tool-win backend not found: ${backendExe}`);
-  process.exit(1);
-}
-
-const backendArgs = process.argv.slice(2);
-const backend = spawn(backendExe, backendArgs, { stdio: ['pipe', 'pipe', 'pipe'] });
-backend.stderr.on('data', (chunk) => process.stderr.write(chunk));
-
-let backendClosed = false;
-backend.on('exit', (code) => {
-  backendClosed = true;
-  logError(`ace-tool-win backend exited (${code ?? 'unknown'})`);
-  process.exit(code ?? 1);
-});
-backend.on('error', (error) => {
-  backendClosed = true;
-  logError(`ace-tool-win backend failed: ${error.message}`);
-  process.exit(1);
-});
-
-let backendRequestId = 1;
-const backendPending = new Map();
-
-function sendBackend(message) {
-  if (backendClosed) {
-    return Promise.reject(new Error('Backend closed'));
-  }
-  const payload = JSON.stringify(message);
-  const header = `Content-Length: ${Buffer.byteLength(payload)}\r\n\r\n`;
-  backend.stdin.write(header + payload);
-  return new Promise((resolve, reject) => {
-    backendPending.set(message.id, { resolve, reject });
-  });
-}
-
-function createParser(onMessage) {
-  let buffer = Buffer.alloc(0);
-  return (chunk) => {
-    buffer = Buffer.concat([buffer, chunk]);
-    while (true) {
-      const headerEnd = buffer.indexOf('\r\n\r\n');
-      if (headerEnd === -1) {
-        return;
-      }
-      const headerText = buffer.slice(0, headerEnd).toString('utf8');
-      const match = headerText.match(/content-length:\s*(\d+)/i);
-      if (!match) {
-        buffer = buffer.slice(headerEnd + 4);
-        continue;
-      }
-      const contentLength = Number(match[1]);
-      const totalLength = headerEnd + 4 + contentLength;
-      if (buffer.length < totalLength) {
-        return;
-      }
-      const body = buffer.slice(headerEnd + 4, totalLength).toString('utf8');
-      buffer = buffer.slice(totalLength);
-      try {
-        const message = JSON.parse(body);
-        onMessage(message);
-      } catch (error) {
-        logError(`Failed to parse backend message: ${error.message}`);
-      }
-    }
-  };
-}
-
-backend.stdout.on('data', createParser((message) => {
-  if (!message || message.id === undefined || message.id === null) {
-    return;
-  }
-  const pending = backendPending.get(message.id);
-  if (!pending) {
-    return;
-  }
-  backendPending.delete(message.id);
-  if (message.error) {
-    pending.reject(message.error);
-  } else {
-    pending.resolve(message);
-  }
-}));
-
-const backendReady = (async () => {
-  const initMessage = {
-    jsonrpc: '2.0',
-    id: backendRequestId++,
-    method: 'initialize',
-    params: {
-      protocolVersion: DEFAULT_PROTOCOL_VERSION,
-      capabilities: {},
-      clientInfo: { name: 'ace-tool-win-proxy', version: '0.1.3' },
-    },
-  };
-
-  await sendBackend(initMessage);
-})().catch((error) => {
-  logError(`Backend initialize failed: ${error?.message || error}`);
-  process.exit(1);
-});
-
-function sendRouter(message) {
-  const payload = JSON.stringify(message);
-  const header = `Content-Length: ${Buffer.byteLength(payload)}\r\n\r\n`;
-  process.stdout.write(header + payload);
-}
-
-function normalizeMethod(method) {
-  const value = (method || '').toLowerCase();
-  if (value === 'tools.list' || value === 'tools/list' || value === 'list_tools' || value === 'listtools') {
-    return 'tools/list';
-  }
-  if (value === 'tools.call' || value === 'tools/call' || value === 'call_tool' || value === 'calltool') {
-    return 'tools/call';
-  }
-  if (value === 'initialize') {
-    return 'initialize';
-  }
-  if (value === 'notifications/initialized' || value === 'initialized') {
-    return 'initialized';
-  }
-  return method || '';
-}
-
-process.stdin.on('data', createParser(async (message) => {
-  if (!message || typeof message !== 'object') {
-    return;
-  }
-
-  const method = normalizeMethod(message.method);
-  const id = message.id;
-
-  if (method === 'initialized') {
-    return;
-  }
-
-  if (method === 'initialize') {
-    const requested = message.params?.protocolVersion;
-    const protocolVersion = SUPPORTED_PROTOCOL_VERSIONS.has(requested) ? requested : DEFAULT_PROTOCOL_VERSION;
-    sendRouter({
-      jsonrpc: '2.0',
-      id,
-      result: {
-        protocolVersion,
-        capabilities: { tools: {}, logging: {} },
-        serverInfo: { name: 'ace-tool-windows', version: '0.1.3' },
-      },
-    });
-    return;
-  }
-
-  if (method === 'tools/list') {
-    await backendReady;
-    const backendMessage = {
-      jsonrpc: '2.0',
-      id: backendRequestId++,
-      method: 'tools/list',
-      params: message.params || {},
-    };
-    try {
-      const response = await sendBackend(backendMessage);
-      if (response.error) {
-        sendRouter({ jsonrpc: '2.0', id, error: response.error });
-      } else {
-        sendRouter({ jsonrpc: '2.0', id, result: response.result });
-      }
-    } catch (error) {
-      sendRouter({
-        jsonrpc: '2.0',
-        id,
-        error: { code: -32000, message: error?.message || 'Backend error' },
-      });
-    }
-    return;
-  }
-
-  if (method === 'tools/call') {
-    await backendReady;
-    const backendMessage = {
-      jsonrpc: '2.0',
-      id: backendRequestId++,
-      method: 'tools/call',
-      params: message.params || {},
-    };
-    try {
-      const response = await sendBackend(backendMessage);
-      if (response.error) {
-        sendRouter({ jsonrpc: '2.0', id, error: response.error });
-      } else {
-        sendRouter({ jsonrpc: '2.0', id, result: response.result });
-      }
-    } catch (error) {
-      sendRouter({
-        jsonrpc: '2.0',
-        id,
-        error: { code: -32000, message: error?.message || 'Backend error' },
-      });
-    }
-    return;
-  }
-
-  if (id !== undefined && id !== null) {
-    sendRouter({
-      jsonrpc: '2.0',
-      id,
-      error: { code: -32601, message: 'Method not found' },
-    });
-  }
-}));
-
-process.stdin.on('end', () => {
-  if (!backendClosed) {
-    backend.kill();
-  }
-});