ace-tool-windows 0.2.7 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,249 +1,264 @@
1
- # ace-tool-windows
2
-
3
- Windows 平台的 ACE MCP Server(Rust + Win32,stdio 模式),提供 `search_context` 与 `enhance_prompt`。
4
-
5
- > 原项目:<https://github.com/eastxiaodong/ace-tool>
6
-
7
- ## 1. 安装
8
-
9
- ```powershell
10
- npm i -g ace-tool-windows
11
- ```
12
-
13
- ## 2. 获取 Token
14
-
15
- 在 <https://acemcp.heroman.wtf> 生成并复制 `token`。
1
+ # ace-tool-windows
2
+
3
+ Windows 平台的 ACE MCP Server(Rust + Win32,stdio 模式),提供 `search_context` 与 `enhance_prompt`。
4
+
5
+ > 原项目:<https://github.com/eastxiaodong/ace-tool>
6
+
7
+ ## 1. 安装
8
+
9
+ ```powershell
10
+ npm i -g ace-tool-windows
11
+ ```
12
+
13
+ ## 2. 获取 Token / API Key
14
+
15
+ 在 <https://acemcp.heroman.wtf> 生成并复制 `token`,供 `search_context` 使用。
16
+
17
+ `codex` 模式下的增强请求改为直连 GPT API,需要额外准备:
18
+ - `codex api base`(例如 `http://your-gpt-gateway/v1`)
19
+ - `codex api key`
20
+ - 可选 `model`(默认 `gpt-5.4`)
16
21
 
17
22
  建议:
18
23
  - 不要把 token 提交到 Git 仓库。
19
24
  - 优先通过环境变量或本地 MCP 配置注入。
20
- - 即便使用 `codex` provider,`search_context` 仍依赖远端服务,必须配置 token
21
-
22
- ## 3. 模式速览(先选一个)
23
-
24
- ### 3.1 `remote` 模式
25
- - 适合:不依赖本机 `codex` CLI,开箱可用。
26
- - 依赖:远端 token/credits。
27
- - 启动示例:
28
-
29
- ```powershell
30
- ace-tool-win --base-url https://acemcp.heroman.wtf/relay/ --token <YOUR_TOKEN> --provider remote
31
- ```
32
-
25
+ - 即便使用 `codex` provider,`search_context` 仍依赖远端服务,必须配置 `--base-url` 与 `--token`。
26
+
27
+ ## 3. 模式速览(先选一个)
28
+
29
+ ### 3.1 `remote` 模式
30
+ - 适合:不依赖本机 `codex` CLI,开箱可用。
31
+ - 依赖:远端 token/credits。
32
+ - 启动示例:
33
+
34
+ ```powershell
35
+ ace-tool-win --base-url https://acemcp.heroman.wtf/relay/ --token <YOUR_TOKEN> --provider remote
36
+ ```
37
+
33
38
  ### 3.2 `codex` 模式
34
- - 适合:希望本地走 Codex 增强,避免远端增强额度影响。
35
- - 依赖:本机可执行 `codex` CLI(`codex --version` 可用)。
39
+ - 适合:希望增强链路直连 GPT API,减少本地 CLI 拉起与进程管理开销。
40
+ - 依赖:可访问的 GPT API 网关、有效 API Key、可用模型名。
36
41
  - 启动示例:
37
42
 
38
43
  ```powershell
39
- ace-tool-win --base-url https://acemcp.heroman.wtf/relay/ --token <YOUR_TOKEN> --provider codex --codex-cmd codex --codex-reasoning-effort low
44
+ ace-tool-win --base-url https://acemcp.heroman.wtf/relay/ --token <YOUR_TOKEN> --provider codex --codex-api-base http://your-gpt-gateway/v1 --codex-api-key <YOUR_GPT_KEY> --codex-model gpt-5.4
40
45
  ```
41
46
 
42
47
  关键说明:
43
48
  - `search_context` 始终走远端,所以即便是 `codex` 模式也必须有可用 token。
44
- - `codex_cmd` 推荐先用 `codex`(PATH 方案,跨设备更稳),确实找不到再写绝对路径。
45
- - 交互窗口支持自适应布局;Codex 首轮超时会自动重试一次 `reasoning_effort=none`。
46
-
47
- ## 4. MCP 配置模板(按模式复制)
48
-
49
- ### 4.1 `remote` 模式模板
50
-
51
- JSON(适用于支持 `mcpServers` 的客户端):
52
-
53
- ```json
54
- {
55
- "mcpServers": {
56
- "ace-tool-windows": {
57
- "command": "ace-tool-win",
58
- "args": [
59
- "--base-url", "https://acemcp.heroman.wtf/relay/",
60
- "--token", "<YOUR_TOKEN>",
61
- "--provider", "remote"
62
- ]
63
- }
64
- }
65
- }
66
- ```
67
-
68
- TOML(Codex CLI):
69
-
70
- ```toml
71
- [mcpServers."ace-tool-windows"]
72
- command = "ace-tool-win"
73
- args = [
74
- "--base-url", "https://acemcp.heroman.wtf/relay/",
75
- "--token", "<YOUR_TOKEN>",
76
- "--provider", "remote"
77
- ]
78
- ```
79
-
49
+ - `codex` 模式现在通过 HTTP 直连 GPT API,不再依赖本机 `codex` CLI。
50
+ - 交互窗口支持自适应布局;增强结果仍会经过现有 UI 确认流程。
51
+
52
+ ## 4. MCP 配置模板(按模式复制)
53
+
54
+ ### 4.1 `remote` 模式模板
55
+
56
+ JSON(适用于支持 `mcpServers` 的客户端):
57
+
58
+ ```json
59
+ {
60
+ "mcpServers": {
61
+ "ace-tool-windows": {
62
+ "command": "ace-tool-win",
63
+ "args": [
64
+ "--base-url", "https://acemcp.heroman.wtf/relay/",
65
+ "--token", "<YOUR_TOKEN>",
66
+ "--provider", "remote"
67
+ ]
68
+ }
69
+ }
70
+ }
71
+ ```
72
+
73
+ TOML(Codex CLI):
74
+
75
+ ```toml
76
+ [mcpServers."ace-tool-windows"]
77
+ command = "ace-tool-win"
78
+ args = [
79
+ "--base-url", "https://acemcp.heroman.wtf/relay/",
80
+ "--token", "<YOUR_TOKEN>",
81
+ "--provider", "remote"
82
+ ]
83
+ ```
84
+
80
85
  ### 4.2 `codex` 模式模板
81
86
 
82
87
  JSON(适用于支持 `mcpServers` 的客户端):
83
-
84
- ```json
85
- {
86
- "mcpServers": {
87
- "ace-tool-windows": {
88
+
89
+ ```json
90
+ {
91
+ "mcpServers": {
92
+ "ace-tool-windows": {
88
93
  "command": "ace-tool-win",
89
94
  "args": [
90
95
  "--base-url", "https://acemcp.heroman.wtf/relay/",
91
96
  "--token", "<YOUR_TOKEN>",
92
97
  "--provider", "codex",
93
- "--codex-cmd", "codex",
94
- "--codex-reasoning-effort", "low"
98
+ "--codex-api-base", "http://your-gpt-gateway/v1",
99
+ "--codex-api-key", "<YOUR_GPT_KEY>",
100
+ "--codex-model", "gpt-5.4"
95
101
  ]
96
102
  }
97
103
  }
98
104
  }
99
- ```
100
-
101
- TOML(Codex CLI):
102
-
103
- ```toml
104
- [mcpServers."ace-tool-windows"]
105
+ ```
106
+
107
+ TOML(Codex CLI):
108
+
109
+ ```toml
110
+ [mcpServers."ace-tool-windows"]
105
111
  command = "ace-tool-win"
106
112
  args = [
107
113
  "--base-url", "https://acemcp.heroman.wtf/relay/",
108
114
  "--token", "<YOUR_TOKEN>",
109
115
  "--provider", "codex",
110
- "--codex-cmd", "codex",
111
- "--codex-reasoning-effort", "low"
116
+ "--codex-api-base", "http://your-gpt-gateway/v1",
117
+ "--codex-api-key", "<YOUR_GPT_KEY>",
118
+ "--codex-model", "gpt-5.4"
112
119
  ]
113
120
  ```
114
-
121
+
115
122
  ## 5. Provider 行为(当前版本)
116
123
 
117
124
  - 启动时确定 provider:`--provider` / `ACE_TOOL_ENHANCE_PROVIDER`,默认 `remote`。
118
125
  - 请求参数里的 `provider` 仅作为提示,不用于切换模式。
119
126
  - 如果请求里的 `provider` 与启动 provider 不一致,会自动忽略,仍以启动 provider 为准。
120
127
  - 不会再自动从 `codex` 降级到 `remote`。
121
-
122
- ## 6. 在 AI CLI 中触发增强
123
-
124
- 配置好 MCP 后,输入包含 `-enhance` 或 `-enhancer` 的请求即可触发 `enhance_prompt`。
125
-
126
- 示例:
127
-
128
- ```text
129
- 为当前项目的代码添加详细注释 -enhance
130
- ```
131
-
132
- 补充:
133
- - 用户输入里的触发后缀(`-enhance` / `-enhancer`)会在增强前自动剥离,不会进入最终增强文本。
134
- - 若本次调用的 `prompt` 仅包含触发后缀,服务端会自动回退到 `conversation_history` 提取可用提示,不再直接报错中断。
135
- - 工具入口统一为 `enhance_prompt`,避免同义工具名导致重复触发。
136
- - 服务端会对短时间内完全相同的增强请求做去重(约 180 秒),避免“窗口刚关又被同参再次拉起”。
137
- - 增强文本采用“语义自适应”排版:在不改变语义前提下提升细节和可读性,不强制固定模板。
138
-
139
- ## 7. 环境变量(按模式)
140
-
141
- ### 7.1 `remote` 模式
142
-
143
- ```powershell
144
- $env:ACE_TOOL_ENHANCE_PROVIDER = "remote"
145
- ```
146
-
128
+ - `codex` provider 当前通过 `/chat/completions` 直连 GPT API。
129
+
130
+ ## 6. 在 AI CLI 中触发增强
131
+
132
+ 配置好 MCP 后,输入包含 `-enhance` 或 `-enhancer` 的请求即可触发 `enhance_prompt`。
133
+
134
+ 示例:
135
+
136
+ ```text
137
+ 为当前项目的代码添加详细注释 -enhance
138
+ ```
139
+
140
+ 补充:
141
+ - 用户输入里的触发后缀(`-enhance` / `-enhancer`)会在增强前自动剥离,不会进入最终增强文本。
142
+ - 若本次调用的 `prompt` 仅包含触发后缀,服务端会自动回退到 `conversation_history` 提取可用提示,不再直接报错中断。
143
+ - 工具入口统一为 `enhance_prompt`,避免同义工具名导致重复触发。
144
+ - 服务端会对短时间内完全相同的增强请求做去重(约 180 秒),避免“窗口刚关又被同参再次拉起”。
145
+ - 增强文本采用“语义自适应”排版:在不改变语义前提下提升细节和可读性,不强制固定模板。
146
+
147
+ ## 7. 环境变量(按模式)
148
+
149
+ ### 7.1 `remote` 模式
150
+
151
+ ```powershell
152
+ $env:ACE_TOOL_ENHANCE_PROVIDER = "remote"
153
+ ```
154
+
147
155
  ### 7.2 `codex` 模式
148
156
 
149
157
  ```powershell
150
158
  $env:ACE_TOOL_ENHANCE_PROVIDER = "codex"
151
- $env:ACE_TOOL_CODEX_CMD = "codex"
152
- $env:ACE_TOOL_CODEX_REASONING_EFFORT = "low"
159
+ $env:ACE_TOOL_CODEX_API_BASE = "http://your-gpt-gateway/v1"
160
+ $env:ACE_TOOL_CODEX_API_KEY = "<YOUR_GPT_KEY>"
161
+ $env:ACE_TOOL_CODEX_MODEL = "gpt-5.4"
153
162
  ```
154
-
155
- ### 7.3 通用变量
156
-
157
- - `ACE_TOOL_ENHANCE_TIMEOUT_SEC=90`(范围 10-600;未显式配置时 `remote` 默认 90 秒,`codex` 默认 180 秒)
158
- - `ACE_TOOL_UI_TIMEOUT_SEC=480`(范围 30-3600)
159
- - `ACE_TOOL_HEADLESS=1`
160
- - `ACE_TOOL_HEADLESS_ACTION=enhanced|end|timeout`
161
- - `ACE_TOOL_DEBUG=1`
162
- - `ACE_TOOL_DEBUG_VERBOSE=1`
163
- - `ACE_TOOL_DEBUG_FILE=<path>`
164
-
163
+
164
+ ### 7.3 通用变量
165
+
166
+ - `ACE_TOOL_ENHANCE_TIMEOUT_SEC=90`(范围 10-600;未显式配置时 `remote` 默认 90 秒,`codex` 默认 180 秒)
167
+ - `ACE_TOOL_UI_TIMEOUT_SEC=480`(范围 30-3600)
168
+ - `ACE_TOOL_HEADLESS=1`
169
+ - `ACE_TOOL_HEADLESS_ACTION=enhanced|end|timeout`
170
+ - `ACE_TOOL_DEBUG=1`
171
+ - `ACE_TOOL_DEBUG_VERBOSE=1`
172
+ - `ACE_TOOL_DEBUG_FILE=<path>`
173
+
165
174
  ## 8. 超时规则
166
175
 
167
176
  - `--enhance-timeout-sec` / `ACE_TOOL_ENHANCE_TIMEOUT_SEC`:增强请求超时,范围 10-600 秒;未显式配置时 `remote` 默认 90 秒,`codex` 默认 180 秒。
168
177
  - `--ui-timeout-sec` / `ACE_TOOL_UI_TIMEOUT_SEC`:UI 会话超时(默认 480 秒,范围 30-3600)。
169
178
  - 超出范围的配置会回退到默认值。
170
179
  - 交互模式下 UI 超时会回退到原始 prompt;headless 模式不显示 UI,由 `ACE_TOOL_HEADLESS_ACTION` 决定动作。
171
- - `codex` provider 在首轮超时时会自动重试一次(`reasoning_effort=none`),用于降低“首次增强卡住”的概率。
172
-
173
- ## 9. 故障排查
174
-
175
- ### 9.1 MCP 启动超时 / 连接失败
180
+ - `codex` provider 的 HTTP 请求会复用上述增强超时。
181
+ - `codex` provider 会对 `429 / 502 / 503 / 504` 以及连接超时自动做最多 3 次重试。
182
+
183
+ ## 9. 故障排查
184
+
185
+ ### 9.1 MCP 启动超时 / 连接失败
186
+
187
+ 检查项:
188
+ - 必须使用 stdio 模式。
189
+ - `command` 路径可执行(绝对路径优先)。
190
+ - `--base-url` 与 `--token` 是否正确。
191
+ - 开启 `ACE_TOOL_DEBUG=1` 查看日志链路。
192
+
193
+ ### 9.2 窗口不弹出或卡住
194
+
195
+ 检查项:
196
+ - 是否启用了 `ACE_TOOL_HEADLESS=1`。
197
+ - Windows 权限或安全软件是否拦截窗口创建。
198
+ - 调试日志中是否出现 `enhance_prompt: opening ui`。
199
+
200
+ ### 9.3 Token 认证失败
201
+
202
+ 典型返回:401 / 403。
203
+
204
+ 处理:
205
+ - 到 <https://acemcp.heroman.wtf> 重新生成 token。
206
+ - 更新 MCP 配置后重启客户端。
207
+
208
+ ### 9.4 中文显示异常 / 乱码
209
+
210
+ 当前版本已增加 UTF-8/BOM/GBK 等解码兜底。若仍异常:
211
+ - 确认终端与编辑器编码为 UTF-8。
212
+ - 打开 `ACE_TOOL_DEBUG=1`,附带日志定位具体节点。
213
+
214
+ ### 9.5 Codex provider 调用失败 / HTTP 返回异常
176
215
 
177
216
  检查项:
178
- - 必须使用 stdio 模式。
179
- - `command` 路径可执行(绝对路径优先)。
180
- - `--base-url` `--token` 是否正确。
181
- - 开启 `ACE_TOOL_DEBUG=1` 查看日志链路。
217
+ - `--codex-api-base` / `ACE_TOOL_CODEX_API_BASE` 是否正确。
218
+ - `--codex-api-key` / `ACE_TOOL_CODEX_API_KEY` 是否有效。
219
+ - `--codex-model` / `ACE_TOOL_CODEX_MODEL` 是否为网关支持的模型名。
220
+ - 开启 `ACE_TOOL_DEBUG=1` 查看错误类型(timeout/auth/network/rate_limit 等)。
182
221
 
183
- ### 9.2 窗口不弹出或卡住
222
+ ### 9.6 Codex 增强慢 / 高概率超时
184
223
 
185
224
  检查项:
186
- - 是否启用了 `ACE_TOOL_HEADLESS=1`。
187
- - Windows 权限或安全软件是否拦截窗口创建。
188
- - 调试日志中是否出现 `enhance_prompt: opening ui`。
189
-
190
- ### 9.3 Token 认证失败
191
-
192
- 典型返回:401 / 403。
193
-
194
- 处理:
195
- - 到 <https://acemcp.heroman.wtf> 重新生成 token。
196
- - 更新 MCP 配置后重启客户端。
197
-
198
- ### 9.4 中文显示异常 / 乱码
199
-
200
- 当前版本已增加 UTF-8/BOM/GBK 等解码兜底。若仍异常:
201
- - 确认终端与编辑器编码为 UTF-8。
202
- - 打开 `ACE_TOOL_DEBUG=1`,附带日志定位具体节点。
203
-
204
- ### 9.5 Codex provider 无法执行 / 退出码非 0
205
-
206
- 检查项:
207
- - `--codex-cmd` 是否指向可执行文件,PATH 是否包含 `codex`。
208
- - 使用相同命令在终端直接执行一次,确认 CLI 可运行。
209
- - 开启 `ACE_TOOL_DEBUG=1` 查看退出码与错误类型(timeout/auth/network 等)。
210
-
211
- ### 9.6 Codex 首次增强慢 / 高概率超时
212
-
213
- 检查项:
214
- - 日志是否长时间停在 `mcp: mcp-router starting`(已默认禁用内部 mcp-router;若仍出现,确认当前进程已重启到新版本)。
215
- - 将 `--codex-reasoning-effort` 临时降到 `none` 或 `low` 观察改善幅度。
225
+ - GPT 网关本身是否响应慢,或上游模型负载是否过高。
226
+ - `--enhance-timeout-sec` 是否过低。
227
+ - 返回是否出现 429 / 5xx,确认是否为限流或服务端波动。
216
228
  - 适当提高 `--enhance-timeout-sec`(例如 240)验证是否为纯耗时问题。
217
229
 
218
- ## 10. 从源码构建
219
-
220
- ```powershell
221
- # release
222
- npm run release
223
-
224
- # 构建并拷贝 bin/ace-tool-win.exe
225
- npm run build:bin
226
-
227
- # 本地打包验证
228
- npm run pack:local
229
- ```
230
-
231
- ## 11. 发布到 npm
232
-
233
- ```powershell
234
- npm publish --access public
235
- ```
236
-
237
- > 若启用 npm 2FA,请使用支持 publish token 或完成二次验证。
238
-
239
- ## 12. 发布前检查清单
240
-
241
- - [ ] `npm run release` 无 error / warning
242
- - [ ] MCP 可启动并能成功 `tools/list`
243
- - [ ] `enhance_prompt` 在 `remote` 与 `codex` 均可回包
244
- - [ ] 中文增强回归通过(无 `???`)
245
- - [ ] README 中配置示例可在新机器复现
246
-
247
- ## License
248
-
230
+ 补充:
231
+ - 当前版本遇到 `429 / 502 / 503 / 504` 或连接超时会自动重试;若仍失败,通常说明上游服务确实不稳定,而不是本地参数拼错。
232
+
233
+ ## 10. 从源码构建
234
+
235
+ ```powershell
236
+ # release
237
+ npm run release
238
+
239
+ # 构建并拷贝 bin/ace-tool-win.exe
240
+ npm run build:bin
241
+
242
+ # 本地打包验证
243
+ npm run pack:local
244
+ ```
245
+
246
+ ## 11. 发布到 npm
247
+
248
+ ```powershell
249
+ npm publish --access public
250
+ ```
251
+
252
+ > 若启用 npm 2FA,请使用支持 publish 的 token 或完成二次验证。
253
+
254
+ ## 12. 发布前检查清单
255
+
256
+ - [ ] `npm run release` 无 error / warning
257
+ - [ ] MCP 可启动并能成功 `tools/list`
258
+ - [ ] `enhance_prompt` 在 `remote` 与 `codex` 均可回包
259
+ - [ ] 中文增强回归通过(无 `???`)
260
+ - [ ] README 中配置示例可在新机器复现
261
+
262
+ ## License
263
+
249
264
  Apache-2.0
Binary file
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ace-tool-windows",
3
- "version": "0.2.7",
3
+ "version": "0.2.8",
4
4
  "description": "ACE MCP server for Windows (Win32)",
5
5
  "bin": {
6
6
  "ace-tool-win": "bin/ace-tool-win.exe"
@@ -17,12 +17,12 @@
17
17
  "LICENSE"
18
18
  ],
19
19
  "license": "Apache-2.0",
20
- "scripts": {
21
- "release": "cargo build --release",
22
- "check:release": "npm run release && cargo test --lib",
23
- "build:bin": "powershell -NoProfile -ExecutionPolicy Bypass -File scripts/build-bin.ps1",
24
- "pack:local": "npm run build:bin && npm pack"
25
- },
20
+ "scripts": {
21
+ "release": "cargo build --release",
22
+ "check:release": "npm run release && cargo test --lib",
23
+ "build:bin": "powershell -NoProfile -ExecutionPolicy Bypass -File scripts/build-bin.ps1",
24
+ "pack:local": "npm run build:bin && npm pack"
25
+ },
26
26
  "repository": {
27
27
  "type": "git",
28
28
  "url": "git+https://github.com/doudouHubs/ace-tool-windows.git"