dsh-acp-enhanced 0.3.0 → 0.3.1
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-zh.md +210 -0
- package/README.md +118 -98
- package/lib/codec.js +34 -0
- package/lib/index.js +44 -12
- package/package.json +3 -2
- package/scripts/dsh-acp-zed.sh +64 -0
- package/README-en.md +0 -223
package/README-zh.md
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
**[English](README.md) | 中文**
|
|
2
|
+
|
|
3
|
+
# dsh-acp-enhanced
|
|
4
|
+
|
|
5
|
+
面向 [DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness)(dsh)的增强版
|
|
6
|
+
[Agent Client Protocol](https://agentclientprotocol.com)(ACP)服务器,为 **Zed** 等 ACP
|
|
7
|
+
编辑器设计。它是官方 `@deepseek-ai/dsh-acp` 桥接器的即插即用替代品:官方桥只做纯文本
|
|
8
|
+
输出,本桥把 Web GUI 的能力(流式、遥测、模型/权限控制、会话管理、MCP)全部暴露到
|
|
9
|
+
ACP 线上。
|
|
10
|
+
|
|
11
|
+
## 特性
|
|
12
|
+
|
|
13
|
+
### 输出与遥测
|
|
14
|
+
|
|
15
|
+
- **块级流式 + 推理流式**:文本块与思考过程实时到达(`agent_message_chunk` /
|
|
16
|
+
`agent_thought_chunk`),取消/重试不留半截输出
|
|
17
|
+
- **完整遥测**:上下文用量环 + 缓存命中率 / TPS / 输入-输出-推理 token / 工具耗时 /
|
|
18
|
+
轮次计数(`usage_update._meta` 携带全量明细)
|
|
19
|
+
|
|
20
|
+
### 模型与权限
|
|
21
|
+
|
|
22
|
+
- **模型切换**:实时 `provider/model` 目录下拉(按 ACP 规范分组线格式)
|
|
23
|
+
- **推理强度**:`reasoning_effort` 下拉——仅当当前路由暴露可选 efforts 时出现
|
|
24
|
+
- **权限预设**:read-only / workspace-write / full-access 三种会话模式
|
|
25
|
+
- **审批**:工具调用弹出原生 allow-once / reject-once 审批
|
|
26
|
+
|
|
27
|
+
### Zed 深度集成
|
|
28
|
+
|
|
29
|
+
- **工具卡片**:展开可见每次调用的完整参数与结果预览(`rawInput` / `rawOutput`),
|
|
30
|
+
按工具类型渲染图标
|
|
31
|
+
- **Zed 文件与终端**:`zed_read_text_file` / `zed_write_text_file` / `zed_terminal` 把
|
|
32
|
+
文件编辑放进 Zed 的"编辑文件"区(diff + 接受/拒绝)、命令跑在 Zed 真实终端
|
|
33
|
+
- **原生表单提问**:`ask_user_question` → `elicitation/create` 表单,选项即点即答
|
|
34
|
+
- **Plan 面板**:plan mode 开关 → Zed 底部"规划中"状态条
|
|
35
|
+
|
|
36
|
+
### 会话
|
|
37
|
+
|
|
38
|
+
- **恢复与归档**:`session/load` 恢复历史线程(完整回放);`session/list` /
|
|
39
|
+
`session/delete` 管理线程归档(带标题、按更新时间排序);标题实时推送
|
|
40
|
+
|
|
41
|
+
### 命令
|
|
42
|
+
|
|
43
|
+
- **Slash 命令**:输入 `/` 即可见命令列表(`available_commands_update`):`/status`
|
|
44
|
+
查看路由与遥测、`/model` 列出或切换模型(列表以等宽代码块排版,一眼全见),其余
|
|
45
|
+
(`/compact` `/goal` `/permission` `/plan`…)直通 harness 命令注册表,全部**不经过
|
|
46
|
+
模型 turn** 即时执行;未解析的 slash 放行给模型(`/skill-name` 技能手势)
|
|
47
|
+
|
|
48
|
+
### MCP
|
|
49
|
+
|
|
50
|
+
- **MCP servers**:`session/new` 的 `mcpServers` 挂载任意 MCP server(stdio +
|
|
51
|
+
streamable HTTP),工具以 `mcp__<server>__<tool>` 注入;失败的 server 不会拖垮会话
|
|
52
|
+
|
|
53
|
+
## 效果预览
|
|
54
|
+
|
|
55
|
+
在 Zed 的 AI Agent 面板中选择 **dsh-acp-enhanced** 后:
|
|
56
|
+
|
|
57
|
+
<img src="assets/screenshots/approval-config-context.png" width="560">
|
|
58
|
+
|
|
59
|
+
<img src="assets/screenshots/tool-cards-elicitation.png" width="560">
|
|
60
|
+
|
|
61
|
+
## 快速开始
|
|
62
|
+
|
|
63
|
+
本包遵循 dsh 官方插件规范(声明了 `dsh.bundle`),安装与官方组合包一致:**一条命令**
|
|
64
|
+
完成,自动初始化 profile、安装包、追加 bundle 层,全程无需手写 profile YAML。
|
|
65
|
+
|
|
66
|
+
### 安装(2 步)
|
|
67
|
+
|
|
68
|
+
**第 1 步:安装**(从 npm registry,无需下载源码)
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
dsh plugin --profile acp-enhanced add dsh-acp-enhanced
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
> 开发/改源码时用 `link:` 指向本地 checkout(改动实时生效):
|
|
75
|
+
> `dsh plugin --profile acp-enhanced add "link:/absolute/path/to/dsh-acp-enhanced"`
|
|
76
|
+
|
|
77
|
+
**第 2 步:注册进 Zed**(在 `~/.config/zed/settings.json` 的 `agent_servers` 里注册;
|
|
78
|
+
Zed 会用极简 PATH 拉起 agent,因此用随附启动器 `scripts/dsh-acp-zed.sh` 定位
|
|
79
|
+
`node`/`dsh`)
|
|
80
|
+
|
|
81
|
+
> **启动器随包发布**,绝对路径取决于第 1 步的安装方式:
|
|
82
|
+
> - **npm 安装(默认)**:`$HOME/.dsh/profiles/acp-enhanced/node_modules/dsh-acp-enhanced/scripts/dsh-acp-zed.sh`。Zed 不会展开 `~` 或环境变量,请把 `$HOME` 换成你的用户目录(如 `/Users/you`)后写全绝对路径。
|
|
83
|
+
> - **`link:` 开发安装**:`<你的 checkout 路径>/scripts/dsh-acp-zed.sh`。
|
|
84
|
+
|
|
85
|
+
#### 最常见:DeepSeek 官方 API(默认路由)
|
|
86
|
+
|
|
87
|
+
```jsonc
|
|
88
|
+
{
|
|
89
|
+
// ...你已有的设置...
|
|
90
|
+
"agent_servers": {
|
|
91
|
+
"dsh-acp-enhanced": {
|
|
92
|
+
"type": "custom",
|
|
93
|
+
"command": "/bin/bash",
|
|
94
|
+
"args": ["/absolute/path/to/dsh-acp-enhanced/scripts/dsh-acp-zed.sh"],
|
|
95
|
+
"env": {
|
|
96
|
+
"DSH_ACP_PROVIDER": "deepseek-official", // 官方 provider id
|
|
97
|
+
"DSH_ACP_MODEL": "deepseek-v4-flash" // 官方模型 id
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
> 这两项 env 与包自带 patch 的缺省值一致,**省略也能工作**——显式写上只是让路由意图
|
|
105
|
+
> 一目了然。API key 不必写进 Zed:存入 `~/.dsh/.credentials.yaml`
|
|
106
|
+
> (`DEEPSEEK_API_KEY`)由 dsh 凭据服务解析即可;启动脚本还会兜底继承正在运行的
|
|
107
|
+
> `dsh web` 进程的 key。
|
|
108
|
+
|
|
109
|
+
可选:固定面板默认项(都可随时在面板里改):
|
|
110
|
+
|
|
111
|
+
```jsonc
|
|
112
|
+
"dsh-acp-enhanced": {
|
|
113
|
+
// ...上面的 type/command/args/env...
|
|
114
|
+
"default_config_options": {
|
|
115
|
+
"model": "deepseek-official/deepseek-v4-flash",
|
|
116
|
+
"plan_mode": false,
|
|
117
|
+
"reasoning_effort": "high"
|
|
118
|
+
},
|
|
119
|
+
"favorite_config_option_values": {
|
|
120
|
+
"model": ["deepseek-official/deepseek-v4-flash", "deepseek-official/deepseek-v4-pro"]
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### 扩展:走 OpenAI-Responses 网关(如公司内部模型网关)
|
|
126
|
+
|
|
127
|
+
同一安装路径,只是 env 换成网关暴露的 provider/model 与它要求的 key 环境变量名:
|
|
128
|
+
|
|
129
|
+
```jsonc
|
|
130
|
+
"dsh-acp-enhanced": {
|
|
131
|
+
"type": "custom",
|
|
132
|
+
"command": "/bin/bash",
|
|
133
|
+
"args": ["/absolute/path/to/dsh-acp-enhanced/scripts/dsh-acp-zed.sh"],
|
|
134
|
+
"env": {
|
|
135
|
+
"DSH_ACP_PROVIDER": "<gateway-provider-id>", // 网关暴露的 provider id
|
|
136
|
+
"DSH_ACP_MODEL": "<gateway-model-id>", // 网关暴露的 model id
|
|
137
|
+
"<KEY_ENV_NAME>": "<key>" // 网关声明读取的 key 环境变量名
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
> `<KEY_ENV_NAME>` 也可以省掉,把 key 存进 `~/.dsh/.credentials.yaml` 统一管理。
|
|
143
|
+
|
|
144
|
+
Zed 会热重载设置。打开 **AI Agent 面板**(`Cmd+Shift+A`)→ agent 选择器选
|
|
145
|
+
**dsh-acp-enhanced** → 输入第一条消息即可:回复实时流式返回,状态栏显示上下文用量,
|
|
146
|
+
面板顶部有 Model / Permission preset / Plan mode 配置项与三种模式,线程归档可恢复
|
|
147
|
+
历史会话。
|
|
148
|
+
|
|
149
|
+
本地验证(无需 Zed):
|
|
150
|
+
|
|
151
|
+
```sh
|
|
152
|
+
node scripts/acp-client.mjs # 官方默认路由,无需 env;期望 ALL CHECKS PASSED
|
|
153
|
+
DSH_ACP_PROVIDER=... DSH_ACP_MODEL=... node scripts/acp-client.mjs # 自定义路由时再传
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### 可选:web_search 走同一个网关
|
|
157
|
+
|
|
158
|
+
若网关实现 OpenAI Responses 的 `web_search` 服务端工具,可把搜索也路由到网关(复用
|
|
159
|
+
同一凭据)。装子包并给 profile 的 `cordis.patch.yml` 追加两段:
|
|
160
|
+
|
|
161
|
+
```sh
|
|
162
|
+
dsh plugin --profile acp-enhanced add dsh-web-search-openrouter
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
```yaml
|
|
166
|
+
- id: web
|
|
167
|
+
config:
|
|
168
|
+
searchProvider: openai-responses # 子包注册在 ctx.web 上的搜索 provider id(固定值)
|
|
169
|
+
|
|
170
|
+
- insert:
|
|
171
|
+
- id: web-search-openrouter
|
|
172
|
+
name: 'dsh-web-search-openrouter'
|
|
173
|
+
config:
|
|
174
|
+
enabled: true
|
|
175
|
+
baseURL: http://<gateway-host>:<port>/v1
|
|
176
|
+
model: <your-model-id>
|
|
177
|
+
apiKeyEnv: <KEY_ENV_NAME>
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
> ⚠️ `searchProvider` 必须**精确等于** `openai-responses`——这是
|
|
181
|
+
> `dsh-web-search-openrouter` 注册在 `ctx.web` 上的搜索 provider id,**不是**网关的
|
|
182
|
+
> LLM provider id(即上面 `DSH_ACP_PROVIDER` 填的那个)。web 插件按 id 精确匹配,
|
|
183
|
+
> 填错时配置期不会报错,直到首次搜索才抛 `WEB_PROVIDER_CONFIGURED_MISSING`。
|
|
184
|
+
|
|
185
|
+
## 故障排查
|
|
186
|
+
|
|
187
|
+
| 症状 | 处理 |
|
|
188
|
+
|---|---|
|
|
189
|
+
| `exec: dsh: not found`(status 127) | 用随附 `dsh-acp-zed.sh` 启动器(自定位 node/dsh) |
|
|
190
|
+
| `no API key for provider route "xxx"` | 写入 `~/.dsh/.credentials.yaml`,或在 agent_servers 里设 `env.DEEPSEEK_API_KEY` |
|
|
191
|
+
| 无法切换模型 / 上下文用量不显示 | 选到了不可路由的"幽灵 provider";本桥默认过滤(只广播 `config.provider` 的模型),确认 profile 的 provider 指向真实路由 |
|
|
192
|
+
| 需要详细诊断 | `ACP_DEBUG=1 dsh --profile acp-enhanced`(stderr 生命周期 trace) |
|
|
193
|
+
|
|
194
|
+
## 开发
|
|
195
|
+
|
|
196
|
+
```sh
|
|
197
|
+
node scripts/acp-client.mjs # 端到端冒烟(需要 API key)
|
|
198
|
+
node scripts/acp-client-tools.mjs # 客户端工具测试(模拟 Zed 的 fs/terminal/elicitation/plan)
|
|
199
|
+
node scripts/acp-mcp-test.mjs # MCP 挂载测试(无模型调用)
|
|
200
|
+
node scripts/acp-smoke-keyless.mjs # keyless 冒烟(CI 用)
|
|
201
|
+
node scripts/acp-resume-test.mjs # 会话恢复测试
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
## 已知限制
|
|
205
|
+
|
|
206
|
+
仅 baseline prompt(无图片/音频附件)、不支持 `additionalDirectories`、文本按块粒度
|
|
207
|
+
流式、每会话同时一个 in-flight prompt。MCP 支持 stdio 与 streamable HTTP(不声明
|
|
208
|
+
legacy SSE / `acp` 传输)。`session/close` / `session/fork` / `session/resume` 未实现
|
|
209
|
+
(不声明能力,合规客户端不会调用);`session/delete` 因 dsh 持久化无官方删除 API,
|
|
210
|
+
采用直接删除后端目录的方式。
|
package/README.md
CHANGED
|
@@ -1,118 +1,127 @@
|
|
|
1
|
-
**[
|
|
1
|
+
**[中文](README-zh.md) | English**
|
|
2
2
|
|
|
3
3
|
# dsh-acp-enhanced
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
[
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
An enhanced [Agent Client Protocol](https://agentclientprotocol.com) (ACP) server for
|
|
6
|
+
[DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (dsh), built for ACP
|
|
7
|
+
editors like **Zed**. It is a drop-in replacement for the official `@deepseek-ai/dsh-acp`
|
|
8
|
+
bridge: the official bridge only streams plain text, this one exposes the Web GUI's
|
|
9
|
+
capabilities — streaming, telemetry, model/permission control, session management, MCP —
|
|
10
|
+
over the ACP wire.
|
|
10
11
|
|
|
11
|
-
##
|
|
12
|
+
## Features
|
|
12
13
|
|
|
13
|
-
###
|
|
14
|
+
### Output & telemetry
|
|
14
15
|
|
|
15
|
-
-
|
|
16
|
-
`agent_thought_chunk
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
- **Block + reasoning streaming**: text blocks and the model's thinking arrive live
|
|
17
|
+
(`agent_message_chunk` / `agent_thought_chunk`); cancelled/retried attempts never leak
|
|
18
|
+
torn output
|
|
19
|
+
- **Full telemetry**: context usage ring plus cache hit rate / TPS / input-output-reasoning
|
|
20
|
+
tokens / tool timing / turn counts (`usage_update._meta` carries the full breakdown)
|
|
19
21
|
|
|
20
|
-
###
|
|
22
|
+
### Model & permissions
|
|
21
23
|
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
|
|
25
|
-
-
|
|
24
|
+
- **Model switching**: live `provider/model` catalog dropdown (ACP grouped-select wire shape)
|
|
25
|
+
- **Reasoning effort**: `reasoning_effort` dropdown — only when the routed model exposes
|
|
26
|
+
selectable efforts
|
|
27
|
+
- **Permission presets**: read-only / workspace-write / full-access session modes
|
|
28
|
+
- **Approval**: native allow-once / reject-once prompts per tool call
|
|
26
29
|
|
|
27
|
-
### Zed
|
|
30
|
+
### Zed deep integration
|
|
28
31
|
|
|
29
|
-
-
|
|
30
|
-
|
|
31
|
-
- **Zed
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
- **
|
|
32
|
+
- **Tool cards**: expand to see each call's full arguments and result preview
|
|
33
|
+
(`rawInput` / `rawOutput`), with per-kind icons
|
|
34
|
+
- **Zed files & terminal**: `zed_read_text_file` / `zed_write_text_file` / `zed_terminal`
|
|
35
|
+
put file edits into Zed's "edited files" area (diff + accept/reject) and commands into a
|
|
36
|
+
real Zed terminal
|
|
37
|
+
- **Native form questions**: `ask_user_question` → `elicitation/create` form, click an
|
|
38
|
+
option, no typing
|
|
39
|
+
- **Plan panel**: plan mode toggle → "planning" status bar in Zed
|
|
35
40
|
|
|
36
|
-
###
|
|
41
|
+
### Sessions
|
|
37
42
|
|
|
38
|
-
-
|
|
39
|
-
`session/delete`
|
|
43
|
+
- **Resume & archive**: `session/load` restores past threads (full replay);
|
|
44
|
+
`session/list` / `session/delete` manage the thread archive (titled, sorted by last
|
|
45
|
+
activity); live title updates
|
|
40
46
|
|
|
41
|
-
###
|
|
47
|
+
### Commands
|
|
42
48
|
|
|
43
|
-
- **Slash
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
49
|
+
- **Slash commands**: typing `/` reveals the command list (`available_commands_update`):
|
|
50
|
+
`/status` shows the route and telemetry, `/model` lists or switches the model (listings
|
|
51
|
+
render as monospace code blocks — readable at a glance), everything
|
|
52
|
+
else (`/compact` `/goal` `/permission` `/plan`…) runs straight through the harness
|
|
53
|
+
command registry — all executed **without a model turn**; unresolved slashes fall
|
|
54
|
+
through to the model (the `/skill-name` skill gesture)
|
|
47
55
|
|
|
48
56
|
### MCP
|
|
49
57
|
|
|
50
|
-
- **MCP servers
|
|
51
|
-
|
|
58
|
+
- **MCP servers**: `session/new` `mcpServers` mount any MCP server (stdio + streamable
|
|
59
|
+
HTTP); tools join as `mcp__<server>__<tool>`; a failing server never takes the session
|
|
60
|
+
down
|
|
52
61
|
|
|
53
|
-
##
|
|
62
|
+
## Preview
|
|
54
63
|
|
|
55
|
-
|
|
64
|
+
After picking **dsh-acp-enhanced** in Zed's AI Agent panel:
|
|
56
65
|
|
|
57
|
-
<img src="assets/screenshots/approval-config-context.png"
|
|
66
|
+
<img src="assets/screenshots/approval-config-context.png" width="560">
|
|
58
67
|
|
|
59
|
-
-
|
|
60
|
-
Plan mode 配置项与上下文用量环。
|
|
68
|
+
<img src="assets/screenshots/tool-cards-elicitation.png" width="560">
|
|
61
69
|
|
|
62
|
-
|
|
70
|
+
## Quick start
|
|
63
71
|
|
|
64
|
-
|
|
65
|
-
|
|
72
|
+
This package follows the official dsh plugin conventions (it declares `dsh.bundle`), so
|
|
73
|
+
installation matches any official bundle: **one command** — auto-initializes the profile,
|
|
74
|
+
installs the package, appends the bundle layer; no profile YAML to write.
|
|
66
75
|
|
|
67
|
-
|
|
76
|
+
### Install (2 steps)
|
|
68
77
|
|
|
69
|
-
|
|
70
|
-
完成,自动初始化 profile、安装包、追加 bundle 层,全程无需手写 profile YAML。
|
|
71
|
-
|
|
72
|
-
### 安装(2 步)
|
|
73
|
-
|
|
74
|
-
**第 1 步:安装**(从 npm registry,无需下载源码)
|
|
78
|
+
**Step 1 — install** (from the npm registry; no source checkout needed):
|
|
75
79
|
|
|
76
80
|
```sh
|
|
77
81
|
dsh plugin --profile acp-enhanced add dsh-acp-enhanced
|
|
78
82
|
```
|
|
79
83
|
|
|
80
|
-
>
|
|
84
|
+
> When hacking on the code, use `link:` to a local checkout instead (live edits):
|
|
81
85
|
> `dsh plugin --profile acp-enhanced add "link:/absolute/path/to/dsh-acp-enhanced"`
|
|
82
86
|
|
|
83
|
-
|
|
84
|
-
Zed
|
|
85
|
-
`node`/`dsh
|
|
87
|
+
**Step 2 — register in Zed** (under `agent_servers` in `~/.config/zed/settings.json`;
|
|
88
|
+
Zed spawns agents with a minimal PATH, so use the shipped launcher
|
|
89
|
+
`scripts/dsh-acp-zed.sh`, which locates `node`/`dsh` itself)
|
|
86
90
|
|
|
87
|
-
|
|
91
|
+
> **The launcher ships with the package.** Its absolute path depends on how you
|
|
92
|
+
> installed in Step 1:
|
|
93
|
+
> - **npm install (default)**: `$HOME/.dsh/profiles/acp-enhanced/node_modules/dsh-acp-enhanced/scripts/dsh-acp-zed.sh` — replace `$HOME` with your home directory (e.g. `/Users/you`); Zed does not expand `~` or env vars, so write the full literal path.
|
|
94
|
+
> - **`link:` dev install**: `<your checkout>/scripts/dsh-acp-zed.sh`.
|
|
95
|
+
|
|
96
|
+
#### Most common: DeepSeek official API (the default route)
|
|
88
97
|
|
|
89
98
|
```jsonc
|
|
90
99
|
{
|
|
91
|
-
//
|
|
100
|
+
// ...your existing settings...
|
|
92
101
|
"agent_servers": {
|
|
93
102
|
"dsh-acp-enhanced": {
|
|
94
103
|
"type": "custom",
|
|
95
104
|
"command": "/bin/bash",
|
|
96
105
|
"args": ["/absolute/path/to/dsh-acp-enhanced/scripts/dsh-acp-zed.sh"],
|
|
97
106
|
"env": {
|
|
98
|
-
"DSH_ACP_PROVIDER": "deepseek-official", //
|
|
99
|
-
"DSH_ACP_MODEL": "deepseek-v4-flash" //
|
|
107
|
+
"DSH_ACP_PROVIDER": "deepseek-official", // the official provider id
|
|
108
|
+
"DSH_ACP_MODEL": "deepseek-v4-flash" // the official model id
|
|
100
109
|
}
|
|
101
110
|
}
|
|
102
111
|
}
|
|
103
112
|
}
|
|
104
113
|
```
|
|
105
114
|
|
|
106
|
-
>
|
|
107
|
-
>
|
|
108
|
-
>
|
|
109
|
-
> `dsh web`
|
|
115
|
+
> Both env vars match the shipped patch's defaults, so **they can be omitted entirely** —
|
|
116
|
+
> writing them out just makes the route explicit. The API key does not have to live in Zed:
|
|
117
|
+
> store it in `~/.dsh/.credentials.yaml` (`DEEPSEEK_API_KEY`) and the dsh credentials
|
|
118
|
+
> service resolves it; the launcher also falls back to a running `dsh web` process's key.
|
|
110
119
|
|
|
111
|
-
|
|
120
|
+
Optional: pin the panel's default config options (all still changeable in the panel):
|
|
112
121
|
|
|
113
122
|
```jsonc
|
|
114
123
|
"dsh-acp-enhanced": {
|
|
115
|
-
//
|
|
124
|
+
// ...the type/command/args/env above...
|
|
116
125
|
"default_config_options": {
|
|
117
126
|
"model": "deepseek-official/deepseek-v4-flash",
|
|
118
127
|
"plan_mode": false,
|
|
@@ -124,9 +133,10 @@ Zed 会用极简 PATH 拉起 agent,因此用随附启动器 `scripts/dsh-acp-z
|
|
|
124
133
|
}
|
|
125
134
|
```
|
|
126
135
|
|
|
127
|
-
####
|
|
136
|
+
#### Extended: route through an OpenAI-Responses gateway (e.g. a company model gateway)
|
|
128
137
|
|
|
129
|
-
|
|
138
|
+
Same install path; only the env values change to the provider/model the gateway exposes
|
|
139
|
+
plus the key env var it requires:
|
|
130
140
|
|
|
131
141
|
```jsonc
|
|
132
142
|
"dsh-acp-enhanced": {
|
|
@@ -134,31 +144,34 @@ Zed 会用极简 PATH 拉起 agent,因此用随附启动器 `scripts/dsh-acp-z
|
|
|
134
144
|
"command": "/bin/bash",
|
|
135
145
|
"args": ["/absolute/path/to/dsh-acp-enhanced/scripts/dsh-acp-zed.sh"],
|
|
136
146
|
"env": {
|
|
137
|
-
"DSH_ACP_PROVIDER": "<gateway-provider-id>", //
|
|
138
|
-
"DSH_ACP_MODEL": "<gateway-model-id>", //
|
|
139
|
-
"<KEY_ENV_NAME>": "<key>" //
|
|
147
|
+
"DSH_ACP_PROVIDER": "<gateway-provider-id>", // provider id exposed by the gateway
|
|
148
|
+
"DSH_ACP_MODEL": "<gateway-model-id>", // model id exposed by the gateway
|
|
149
|
+
"<KEY_ENV_NAME>": "<key>" // the key env var the gateway reads
|
|
140
150
|
}
|
|
141
151
|
}
|
|
142
152
|
```
|
|
143
153
|
|
|
144
|
-
> `<KEY_ENV_NAME>`
|
|
154
|
+
> `<KEY_ENV_NAME>` can also be omitted and the key stored in
|
|
155
|
+
> `~/.dsh/.credentials.yaml` instead.
|
|
145
156
|
|
|
146
|
-
Zed
|
|
147
|
-
**dsh-acp-enhanced** →
|
|
148
|
-
|
|
149
|
-
|
|
157
|
+
Zed hot-reloads settings. Open the **AI Agent panel** (`Cmd+Shift+A`) → pick
|
|
158
|
+
**dsh-acp-enhanced** in the agent selector → send your first message: replies stream in
|
|
159
|
+
real time, the status bar shows context usage, the panel exposes Model / Permission preset
|
|
160
|
+
/ Plan mode options plus three modes, and the thread archive lists and resumes past
|
|
161
|
+
sessions.
|
|
150
162
|
|
|
151
|
-
|
|
163
|
+
Verify locally (no Zed needed):
|
|
152
164
|
|
|
153
165
|
```sh
|
|
154
|
-
node scripts/acp-client.mjs #
|
|
155
|
-
DSH_ACP_PROVIDER=... DSH_ACP_MODEL=... node scripts/acp-client.mjs #
|
|
166
|
+
node scripts/acp-client.mjs # official default route, no env; expect ALL CHECKS PASSED
|
|
167
|
+
DSH_ACP_PROVIDER=... DSH_ACP_MODEL=... node scripts/acp-client.mjs # only for a custom route
|
|
156
168
|
```
|
|
157
169
|
|
|
158
|
-
###
|
|
170
|
+
### Optional: route web_search through the same gateway
|
|
159
171
|
|
|
160
|
-
|
|
161
|
-
|
|
172
|
+
If the gateway implements the OpenAI Responses `web_search` server tool, you can route
|
|
173
|
+
search through it too (reusing the same credential). Install the sub-package and append
|
|
174
|
+
two blocks to the profile's `cordis.patch.yml`:
|
|
162
175
|
|
|
163
176
|
```sh
|
|
164
177
|
dsh plugin --profile acp-enhanced add dsh-web-search-openrouter
|
|
@@ -167,7 +180,7 @@ dsh plugin --profile acp-enhanced add dsh-web-search-openrouter
|
|
|
167
180
|
```yaml
|
|
168
181
|
- id: web
|
|
169
182
|
config:
|
|
170
|
-
searchProvider:
|
|
183
|
+
searchProvider: openai-responses # the search provider id this sub-package registers on ctx.web (fixed value)
|
|
171
184
|
|
|
172
185
|
- insert:
|
|
173
186
|
- id: web-search-openrouter
|
|
@@ -179,29 +192,36 @@ dsh plugin --profile acp-enhanced add dsh-web-search-openrouter
|
|
|
179
192
|
apiKeyEnv: <KEY_ENV_NAME>
|
|
180
193
|
```
|
|
181
194
|
|
|
182
|
-
|
|
195
|
+
> ⚠️ `searchProvider` must be **exactly** `openai-responses` — the search provider id
|
|
196
|
+
> `dsh-web-search-openrouter` registers on `ctx.web`. It is **not** your gateway's LLM
|
|
197
|
+
> provider id (the one you put in `DSH_ACP_PROVIDER` above). The `web` plugin matches it
|
|
198
|
+
> exactly, so a wrong value produces no error at config time and only fails at the first
|
|
199
|
+
> search with `WEB_PROVIDER_CONFIGURED_MISSING`.
|
|
200
|
+
|
|
201
|
+
## Troubleshooting
|
|
183
202
|
|
|
184
|
-
|
|
|
203
|
+
| Symptom | Fix |
|
|
185
204
|
|---|---|
|
|
186
|
-
| `exec: dsh: not found
|
|
187
|
-
| `no API key for provider route "xxx"` |
|
|
188
|
-
|
|
|
189
|
-
|
|
|
205
|
+
| `exec: dsh: not found` (status 127) | Use the shipped `dsh-acp-zed.sh` launcher (locates node/dsh itself) |
|
|
206
|
+
| `no API key for provider route "xxx"` | Write `~/.dsh/.credentials.yaml`, or set `env.DEEPSEEK_API_KEY` on the agent_servers entry |
|
|
207
|
+
| Cannot switch models / context usage missing | A "phantom provider" route was picked; this bridge filters them by default (only `config.provider`'s models are advertised) — point the profile's provider at a real route |
|
|
208
|
+
| Need detailed diagnostics | `ACP_DEBUG=1 dsh --profile acp-enhanced` (stderr lifecycle trace) |
|
|
190
209
|
|
|
191
|
-
##
|
|
210
|
+
## Development
|
|
192
211
|
|
|
193
212
|
```sh
|
|
194
|
-
node scripts/acp-client.mjs #
|
|
195
|
-
node scripts/acp-client-tools.mjs #
|
|
196
|
-
node scripts/acp-mcp-test.mjs # MCP
|
|
197
|
-
node scripts/acp-smoke-keyless.mjs # keyless
|
|
198
|
-
node scripts/acp-resume-test.mjs #
|
|
213
|
+
node scripts/acp-client.mjs # end-to-end smoke (needs an API key)
|
|
214
|
+
node scripts/acp-client-tools.mjs # client-tool tests (mocks Zed fs/terminal/elicitation/plan)
|
|
215
|
+
node scripts/acp-mcp-test.mjs # MCP mount test (no model calls)
|
|
216
|
+
node scripts/acp-smoke-keyless.mjs # keyless boot smoke (CI)
|
|
217
|
+
node scripts/acp-resume-test.mjs # session resume test
|
|
199
218
|
```
|
|
200
219
|
|
|
201
|
-
##
|
|
220
|
+
## Known limitations
|
|
202
221
|
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
legacy SSE / `acp`
|
|
206
|
-
|
|
207
|
-
|
|
222
|
+
Baseline prompts only (no image/audio attachments), no `additionalDirectories`, text
|
|
223
|
+
streams at block granularity, one in-flight prompt per session. MCP supports stdio and
|
|
224
|
+
streamable HTTP (legacy SSE / `acp` transports are not advertised).
|
|
225
|
+
`session/close` / `session/fork` / `session/resume` are not implemented (capabilities
|
|
226
|
+
undeclared, compliant clients will not call them); `session/delete` removes the persisted
|
|
227
|
+
directory directly because dsh persistence has no official delete API.
|
package/lib/codec.js
CHANGED
|
@@ -57,6 +57,40 @@ export function promptHasUnsupportedContent(prompt) {
|
|
|
57
57
|
return prompt.some((block) => block.type !== 'text' && block.type !== 'resource_link')
|
|
58
58
|
}
|
|
59
59
|
|
|
60
|
+
/** Kramdown attribute-style inline markup (SiYuan exports), including
|
|
61
|
+
* truncation-damaged tails — titles are byte-budgeted upstream, so a cut
|
|
62
|
+
* can land mid-attribute (unterminated `"` or no closing `]`):
|
|
63
|
+
* `[resource_link name="..." url="..."]`, `[file_link ...]`, `[ref ...]`. */
|
|
64
|
+
const KRAMDOWN_ATTR_MARKUP = /\[[^\]]*="[^\]]*\]|\[[^\]]*="[^\]]*$/g
|
|
65
|
+
|
|
66
|
+
/** Tight markdown link `[label](url)` — kept as the label only. */
|
|
67
|
+
const MARKDOWN_LINK = /\[([^\]]+)\]\(([^)\s]+)\)/g
|
|
68
|
+
|
|
69
|
+
/** Human-facing attribute kept when stripping kramdown markup; the closing
|
|
70
|
+
* quote is optional so a value truncated at the byte budget still survives. */
|
|
71
|
+
const ATTR_NAME_OR_TEXT = /(?:name|text)="([^"]*)"?/i
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Sanitize a session title for display on the ACP wire. Titles derive from
|
|
75
|
+
* raw first-prompt text, which often carries pasted markup — SiYuan's
|
|
76
|
+
* kramdown `[resource_link ...]` / `[file_link ...]` / `[ref ...]` inline
|
|
77
|
+
* syntax (possibly truncated mid-markup), or plain markdown links. Keeps the
|
|
78
|
+
* human-facing name/text (or the markdown label) and collapses whitespace
|
|
79
|
+
* to a single line.
|
|
80
|
+
* @param input - untrusted title text (raw or upstream-normalized).
|
|
81
|
+
* @returns the cleaned title; `''` when nothing visible remains.
|
|
82
|
+
*/
|
|
83
|
+
export function sanitizeWireTitle(input) {
|
|
84
|
+
return String(input ?? '')
|
|
85
|
+
.replace(MARKDOWN_LINK, '$1')
|
|
86
|
+
.replace(KRAMDOWN_ATTR_MARKUP, (match) => {
|
|
87
|
+
const keep = ATTR_NAME_OR_TEXT.exec(match)
|
|
88
|
+
return keep === null ? '' : keep[1]
|
|
89
|
+
})
|
|
90
|
+
.replace(/\s+/g, ' ')
|
|
91
|
+
.trim()
|
|
92
|
+
}
|
|
93
|
+
|
|
60
94
|
/**
|
|
61
95
|
* Compute the usage telemetry snapshot for one provider-reported usage sample.
|
|
62
96
|
* @param usage - TokenUsage { inputTokens, outputTokens, cacheReadTokens?, cacheWriteTokens?, reasoningTokens? }.
|
package/lib/index.js
CHANGED
|
@@ -31,6 +31,7 @@
|
|
|
31
31
|
|
|
32
32
|
import { randomUUID } from 'node:crypto'
|
|
33
33
|
import { rm } from 'node:fs/promises'
|
|
34
|
+
import { createRequire } from 'node:module'
|
|
34
35
|
import { isAbsolute, dirname } from 'node:path'
|
|
35
36
|
import { Readable, Writable } from 'node:stream'
|
|
36
37
|
import Schema from '@deepseek-ai/schemastery'
|
|
@@ -39,7 +40,11 @@ import { createUserMessage, errorChain, ReasoningEffortId } from '@deepseek-ai/d
|
|
|
39
40
|
import { installModelSelection } from '@deepseek-ai/dsh-agent'
|
|
40
41
|
import { defineTool } from '@deepseek-ai/dsh-tools'
|
|
41
42
|
import { SessionId } from '@deepseek-ai/dsh-session'
|
|
42
|
-
import { acpPromptToText, promptHasUnsupportedContent, turnEndToStopReason, usageTelemetry } from './codec.js'
|
|
43
|
+
import { acpPromptToText, promptHasUnsupportedContent, sanitizeWireTitle, turnEndToStopReason, usageTelemetry } from './codec.js'
|
|
44
|
+
|
|
45
|
+
/** Agent version advertised on the ACP wire — read from package.json so the
|
|
46
|
+
* handshake can never drift from the released package version. */
|
|
47
|
+
const AGENT_VERSION = createRequire(import.meta.url)('../package.json').version
|
|
43
48
|
|
|
44
49
|
export const name = 'acp-enhanced'
|
|
45
50
|
/** The bridge creates and owns agents; every other concern is carried by the composition. */
|
|
@@ -282,7 +287,10 @@ export function apply(ctx, config) {
|
|
|
282
287
|
if (event.data.contextWindow !== undefined) record.contextWindow = event.data.contextWindow
|
|
283
288
|
break
|
|
284
289
|
case 'session/title': {
|
|
285
|
-
|
|
290
|
+
// Titles derive from raw first-prompt text; sanitize before the wire
|
|
291
|
+
// so pasted markup (e.g. SiYuan `[resource_link ...]`) can't leak
|
|
292
|
+
// into Zed's thread title.
|
|
293
|
+
const title = sanitizeWireTitle(event.data.title)
|
|
286
294
|
if (typeof title === 'string' && title.length > 0) {
|
|
287
295
|
record.title = title
|
|
288
296
|
publishSessionInfo(record, {
|
|
@@ -1037,19 +1045,35 @@ export function apply(ctx, config) {
|
|
|
1037
1045
|
})
|
|
1038
1046
|
}
|
|
1039
1047
|
|
|
1048
|
+
/**
|
|
1049
|
+
* Advertise the command surface *after* the current request response is
|
|
1050
|
+
* written. A fresh `session/new` id is generated server-side, so the client
|
|
1051
|
+
* cannot route session notifications for it until the response arrives; an
|
|
1052
|
+
* `available_commands_update` queued before that response is dropped and
|
|
1053
|
+
* the slash menu stays empty ("Available commands: none").
|
|
1054
|
+
*/
|
|
1055
|
+
function publishCommandsAfterResponse(record) {
|
|
1056
|
+
setImmediate(() => {
|
|
1057
|
+
publishCommands(record).catch((error) => {
|
|
1058
|
+
logger.warn(`acp-enhanced: command broadcast failed: ${String(error)}`)
|
|
1059
|
+
})
|
|
1060
|
+
})
|
|
1061
|
+
}
|
|
1062
|
+
|
|
1040
1063
|
/** Text summary of one session: route, turns, last usage telemetry. */
|
|
1041
1064
|
async function statusText(record) {
|
|
1042
1065
|
const selection = record.selection.current
|
|
1043
1066
|
const last = record.lastUsage
|
|
1044
1067
|
const lines = [
|
|
1045
|
-
`route
|
|
1046
|
-
`turns
|
|
1068
|
+
`route ${selection.provider ?? '?'}/${selection.model ?? '?'}`,
|
|
1069
|
+
`turns ${record.turnCount}`,
|
|
1047
1070
|
...last === undefined ? [] : [
|
|
1048
|
-
`context
|
|
1049
|
-
`last usage
|
|
1071
|
+
`context ${last.used}/${last.size}`,
|
|
1072
|
+
`last usage ${last.meta.inputTokens ?? '?'}/${last.meta.outputTokens ?? '?'} in/out, ${last.meta.reasoningTokens ?? '?'} reasoning, cache hit ${last.meta.cacheHitRate ?? '?'}%, ${last.meta.tps ?? '?'} tps`,
|
|
1050
1073
|
],
|
|
1051
1074
|
]
|
|
1052
|
-
|
|
1075
|
+
// Monospace code block: aligned columns at a glance, no interaction needed.
|
|
1076
|
+
return ['```', ...lines, '```'].join('\n')
|
|
1053
1077
|
}
|
|
1054
1078
|
|
|
1055
1079
|
/** The /model command: list the live catalog or switch by exact id/substring. */
|
|
@@ -1061,7 +1085,8 @@ export function apply(ctx, config) {
|
|
|
1061
1085
|
const mark = `${group.id}/${model.id}` === `${current.provider}/${current.model}` ? '* ' : ' '
|
|
1062
1086
|
return `${mark}${group.id}/${model.id}`
|
|
1063
1087
|
}))
|
|
1064
|
-
|
|
1088
|
+
// Monospace code block: aligned catalog, no interaction needed.
|
|
1089
|
+
return lines.length > 0 ? ['```', ...lines, '```'].join('\n') : 'no models available'
|
|
1065
1090
|
}
|
|
1066
1091
|
const needle = query.trim().toLowerCase()
|
|
1067
1092
|
const matches = catalog.flatMap((group) => group.models.map((model) => ({ provider: group.id, model: model.id })))
|
|
@@ -1155,7 +1180,9 @@ export function apply(ctx, config) {
|
|
|
1155
1180
|
// Malformed line — skip; titles live on well-formed rows.
|
|
1156
1181
|
}
|
|
1157
1182
|
}
|
|
1158
|
-
|
|
1183
|
+
// Stored titles are the raw upstream text (the sanitizer runs on the
|
|
1184
|
+
// live path only); clean them here so replay shows the same wire shape.
|
|
1185
|
+
return last === undefined ? undefined : sanitizeWireTitle(last)
|
|
1159
1186
|
} catch {
|
|
1160
1187
|
return undefined
|
|
1161
1188
|
}
|
|
@@ -1291,7 +1318,7 @@ export function apply(ctx, config) {
|
|
|
1291
1318
|
syncClientTools()
|
|
1292
1319
|
return Promise.resolve({
|
|
1293
1320
|
protocolVersion: PROTOCOL_VERSION,
|
|
1294
|
-
agentInfo: { name: 'deepseek-harness-acp-enhanced', version:
|
|
1321
|
+
agentInfo: { name: 'deepseek-harness-acp-enhanced', version: AGENT_VERSION },
|
|
1295
1322
|
agentCapabilities: {
|
|
1296
1323
|
loadSession: true,
|
|
1297
1324
|
sessionCapabilities: { list: {}, delete: {} },
|
|
@@ -1327,7 +1354,7 @@ export function apply(ctx, config) {
|
|
|
1327
1354
|
const record = makeRecord(handle)
|
|
1328
1355
|
sessions.set(sessionId, record)
|
|
1329
1356
|
await syncMcpServers(params.mcpServers, params.cwd)
|
|
1330
|
-
|
|
1357
|
+
publishCommandsAfterResponse(record)
|
|
1331
1358
|
const permission = permissionPresets()
|
|
1332
1359
|
return {
|
|
1333
1360
|
sessionId,
|
|
@@ -1389,7 +1416,7 @@ export function apply(ctx, config) {
|
|
|
1389
1416
|
// Zed inserts the thread before the load RPC completes; replay the
|
|
1390
1417
|
// conversation history as notifications so the thread renders.
|
|
1391
1418
|
await replayHistory(record)
|
|
1392
|
-
|
|
1419
|
+
publishCommandsAfterResponse(record)
|
|
1393
1420
|
const permission = permissionPresets()
|
|
1394
1421
|
return {
|
|
1395
1422
|
...permission === undefined ? {} : {
|
|
@@ -1421,6 +1448,11 @@ export function apply(ctx, config) {
|
|
|
1421
1448
|
const text = acpPromptToText(params.prompt)
|
|
1422
1449
|
if (text.trim().length === 0) throw invalidParams('empty prompt')
|
|
1423
1450
|
|
|
1451
|
+
// Insurance: by the first prompt the client is guaranteed to know the
|
|
1452
|
+
// session, so re-advertise the command surface (idempotent) — covers
|
|
1453
|
+
// any client that missed the post-session/new broadcast.
|
|
1454
|
+
publishCommands(record)
|
|
1455
|
+
|
|
1424
1456
|
// Adapter-level slash commands never reach the model: /status and
|
|
1425
1457
|
// /model are built in, any other registered slash (compact/goal/
|
|
1426
1458
|
// permission/plan/…) runs through the harness command registry
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "dsh-acp-enhanced",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.1",
|
|
4
4
|
"description": "Enhanced ACP server for DeepSeek Harness: block-level streaming, usage/stat telemetry (cache hit rate, token speed, input/output tokens, context length, turns, tool timing), model & reasoning-effort switching, and permission-preset control over the ACP wire (Zed-friendly)",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"dsh",
|
|
@@ -23,9 +23,10 @@
|
|
|
23
23
|
"files": [
|
|
24
24
|
"lib",
|
|
25
25
|
"profile",
|
|
26
|
+
"scripts/dsh-acp-zed.sh",
|
|
26
27
|
"cordis.patch.yml",
|
|
27
28
|
"README.md",
|
|
28
|
-
"README-
|
|
29
|
+
"README-zh.md",
|
|
29
30
|
"LICENSE"
|
|
30
31
|
],
|
|
31
32
|
"scripts": {
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
# Zed launcher for dsh-acp-enhanced.
|
|
3
|
+
#
|
|
4
|
+
# Zed (a GUI app) spawns agent processes with a minimal PATH that usually does
|
|
5
|
+
# NOT include node or dsh, so this wrapper locates both itself:
|
|
6
|
+
# - node: PATH, /opt/homebrew/bin, /usr/local/bin, ~/.nvm/versions/node/*
|
|
7
|
+
# - dsh: PATH, the npx cache (~/.npm/_npx/*/node_modules/.bin), the global
|
|
8
|
+
# npm prefix bin dir, /opt/homebrew/bin, /usr/local/bin
|
|
9
|
+
# and prepends the node dir to PATH so dsh's `#!/usr/bin/env node` shebang
|
|
10
|
+
# resolves.
|
|
11
|
+
#
|
|
12
|
+
# The profile resolves DEEPSEEK_API_KEY through the dsh credentials service
|
|
13
|
+
# (~/.dsh/.credentials.yaml), so no environment plumbing is required; an
|
|
14
|
+
# explicit DEEPSEEK_API_KEY from Zed's agent_servers.env wins, and a running
|
|
15
|
+
# `dsh web` process is a final fallback source.
|
|
16
|
+
#
|
|
17
|
+
# stdout stays the ACP JSON-RPC wire; diagnostics go to stderr.
|
|
18
|
+
set -u
|
|
19
|
+
|
|
20
|
+
NODE_BIN="$(command -v node 2>/dev/null || true)"
|
|
21
|
+
if [ -z "${NODE_BIN}" ]; then
|
|
22
|
+
for candidate in \
|
|
23
|
+
/opt/homebrew/bin/node \
|
|
24
|
+
/usr/local/bin/node \
|
|
25
|
+
"$HOME"/.nvm/versions/node/*/bin/node; do
|
|
26
|
+
if [ -x "${candidate}" ]; then
|
|
27
|
+
NODE_BIN="${candidate}"
|
|
28
|
+
break
|
|
29
|
+
fi
|
|
30
|
+
done
|
|
31
|
+
fi
|
|
32
|
+
if [ -n "${NODE_BIN}" ]; then
|
|
33
|
+
export PATH="$(dirname "${NODE_BIN}"):${PATH}"
|
|
34
|
+
fi
|
|
35
|
+
|
|
36
|
+
DASH_BIN="$(command -v dsh 2>/dev/null || true)"
|
|
37
|
+
if [ -z "${DASH_BIN}" ]; then
|
|
38
|
+
for candidate in \
|
|
39
|
+
"$HOME"/.npm/_npx/*/node_modules/.bin/dsh \
|
|
40
|
+
"$(npm prefix -g 2>/dev/null)/bin/dsh" \
|
|
41
|
+
/opt/homebrew/bin/dsh \
|
|
42
|
+
/usr/local/bin/dsh; do
|
|
43
|
+
if [ -x "${candidate}" ]; then
|
|
44
|
+
DASH_BIN="${candidate}"
|
|
45
|
+
break
|
|
46
|
+
fi
|
|
47
|
+
done
|
|
48
|
+
fi
|
|
49
|
+
if [ -z "${NODE_BIN}" ] || [ -z "${DASH_BIN}" ]; then
|
|
50
|
+
echo "dsh-acp-zed: cannot locate node and/or dsh (node='${NODE_BIN}' dsh='${DASH_BIN}'); install them or set PATH" >&2
|
|
51
|
+
exit 127
|
|
52
|
+
fi
|
|
53
|
+
|
|
54
|
+
if [ -z "${DEEPSEEK_API_KEY:-}" ]; then
|
|
55
|
+
WEB_PID="$(pgrep -f 'dsh web' | head -n 1)"
|
|
56
|
+
if [ -n "${WEB_PID}" ]; then
|
|
57
|
+
KEY="$(ps eww "${WEB_PID}" 2>/dev/null | tr ' ' '\n' | grep '^DEEPSEEK_API_KEY=' | cut -d= -f2-)"
|
|
58
|
+
if [ -n "${KEY}" ]; then
|
|
59
|
+
export DEEPSEEK_API_KEY="${KEY}"
|
|
60
|
+
fi
|
|
61
|
+
fi
|
|
62
|
+
fi
|
|
63
|
+
|
|
64
|
+
exec "${DASH_BIN}" --profile acp-enhanced "$@"
|
package/README-en.md
DELETED
|
@@ -1,223 +0,0 @@
|
|
|
1
|
-
**[中文](README.md) | English**
|
|
2
|
-
|
|
3
|
-
# dsh-acp-enhanced
|
|
4
|
-
|
|
5
|
-
An enhanced [Agent Client Protocol](https://agentclientprotocol.com) (ACP) server for
|
|
6
|
-
[DeepSeek Harness](https://github.com/deepseek-ai/deepseek-harness) (dsh), built for ACP
|
|
7
|
-
editors like **Zed**. It is a drop-in replacement for the official `@deepseek-ai/dsh-acp`
|
|
8
|
-
bridge: the official bridge only streams plain text, this one exposes the Web GUI's
|
|
9
|
-
capabilities — streaming, telemetry, model/permission control, session management, MCP —
|
|
10
|
-
over the ACP wire.
|
|
11
|
-
|
|
12
|
-
## Features
|
|
13
|
-
|
|
14
|
-
### Output & telemetry
|
|
15
|
-
|
|
16
|
-
- **Block + reasoning streaming**: text blocks and the model's thinking arrive live
|
|
17
|
-
(`agent_message_chunk` / `agent_thought_chunk`); cancelled/retried attempts never leak
|
|
18
|
-
torn output
|
|
19
|
-
- **Full telemetry**: context usage ring plus cache hit rate / TPS / input-output-reasoning
|
|
20
|
-
tokens / tool timing / turn counts (`usage_update._meta` carries the full breakdown)
|
|
21
|
-
|
|
22
|
-
### Model & permissions
|
|
23
|
-
|
|
24
|
-
- **Model switching**: live `provider/model` catalog dropdown (ACP grouped-select wire shape)
|
|
25
|
-
- **Reasoning effort**: `reasoning_effort` dropdown — only when the routed model exposes
|
|
26
|
-
selectable efforts
|
|
27
|
-
- **Permission presets**: read-only / workspace-write / full-access session modes
|
|
28
|
-
- **Approval**: native allow-once / reject-once prompts per tool call
|
|
29
|
-
|
|
30
|
-
### Zed deep integration
|
|
31
|
-
|
|
32
|
-
- **Tool cards**: expand to see each call's full arguments and result preview
|
|
33
|
-
(`rawInput` / `rawOutput`), with per-kind icons
|
|
34
|
-
- **Zed files & terminal**: `zed_read_text_file` / `zed_write_text_file` / `zed_terminal`
|
|
35
|
-
put file edits into Zed's "edited files" area (diff + accept/reject) and commands into a
|
|
36
|
-
real Zed terminal
|
|
37
|
-
- **Native form questions**: `ask_user_question` → `elicitation/create` form, click an
|
|
38
|
-
option, no typing
|
|
39
|
-
- **Plan panel**: plan mode toggle → "planning" status bar in Zed
|
|
40
|
-
|
|
41
|
-
### Sessions
|
|
42
|
-
|
|
43
|
-
- **Resume & archive**: `session/load` restores past threads (full replay);
|
|
44
|
-
`session/list` / `session/delete` manage the thread archive (titled, sorted by last
|
|
45
|
-
activity); live title updates
|
|
46
|
-
|
|
47
|
-
### Commands
|
|
48
|
-
|
|
49
|
-
- **Slash commands**: typing `/` reveals the command list (`available_commands_update`):
|
|
50
|
-
`/status` shows the route and telemetry, `/model` lists or switches the model, everything
|
|
51
|
-
else (`/compact` `/goal` `/permission` `/plan`…) runs straight through the harness
|
|
52
|
-
command registry — all executed **without a model turn**; unresolved slashes fall
|
|
53
|
-
through to the model (the `/skill-name` skill gesture)
|
|
54
|
-
|
|
55
|
-
### MCP
|
|
56
|
-
|
|
57
|
-
- **MCP servers**: `session/new` `mcpServers` mount any MCP server (stdio + streamable
|
|
58
|
-
HTTP); tools join as `mcp__<server>__<tool>`; a failing server never takes the session
|
|
59
|
-
down
|
|
60
|
-
|
|
61
|
-
## Preview
|
|
62
|
-
|
|
63
|
-
After picking **dsh-acp-enhanced** in Zed's AI Agent panel:
|
|
64
|
-
|
|
65
|
-
<img src="assets/screenshots/approval-config-context.png" alt="Approval popup, model/reasoning-effort switches, context ring" width="560">
|
|
66
|
-
|
|
67
|
-
- Tool calls that need permission pop a **native approval prompt**; below the input box sit
|
|
68
|
-
the model, reasoning effort, permission preset, plan mode options and the context usage
|
|
69
|
-
ring.
|
|
70
|
-
|
|
71
|
-
<img src="assets/screenshots/tool-cards-elicitation.png" alt="Tool call inputs and outputs, native Zed question form" width="320">
|
|
72
|
-
|
|
73
|
-
- **Tool cards** expand to show full arguments and result previews; when dsh needs your
|
|
74
|
-
confirmation or a choice, the question arrives as a **native Zed form** — click an
|
|
75
|
-
option, no typing.
|
|
76
|
-
|
|
77
|
-
## Quick start
|
|
78
|
-
|
|
79
|
-
This package follows the official dsh plugin conventions (it declares `dsh.bundle`), so
|
|
80
|
-
installation matches any official bundle: **one command** — auto-initializes the profile,
|
|
81
|
-
installs the package, appends the bundle layer; no profile YAML to write.
|
|
82
|
-
|
|
83
|
-
### Install (2 steps)
|
|
84
|
-
|
|
85
|
-
**Step 1 — install** (from the npm registry; no source checkout needed):
|
|
86
|
-
|
|
87
|
-
```sh
|
|
88
|
-
dsh plugin --profile acp-enhanced add dsh-acp-enhanced
|
|
89
|
-
```
|
|
90
|
-
|
|
91
|
-
> When hacking on the code, use `link:` to a local checkout instead (live edits):
|
|
92
|
-
> `dsh plugin --profile acp-enhanced add "link:/absolute/path/to/dsh-acp-enhanced"`
|
|
93
|
-
|
|
94
|
-
**Step 2 — register in Zed** (under `agent_servers` in `~/.config/zed/settings.json`;
|
|
95
|
-
Zed spawns agents with a minimal PATH, so use the shipped launcher
|
|
96
|
-
`scripts/dsh-acp-zed.sh`, which locates `node`/`dsh` itself)
|
|
97
|
-
|
|
98
|
-
#### Most common: DeepSeek official API (the default route)
|
|
99
|
-
|
|
100
|
-
```jsonc
|
|
101
|
-
{
|
|
102
|
-
// ...your existing settings...
|
|
103
|
-
"agent_servers": {
|
|
104
|
-
"dsh-acp-enhanced": {
|
|
105
|
-
"type": "custom",
|
|
106
|
-
"command": "/bin/bash",
|
|
107
|
-
"args": ["/absolute/path/to/dsh-acp-enhanced/scripts/dsh-acp-zed.sh"],
|
|
108
|
-
"env": {
|
|
109
|
-
"DSH_ACP_PROVIDER": "deepseek-official", // the official provider id
|
|
110
|
-
"DSH_ACP_MODEL": "deepseek-v4-flash" // the official model id
|
|
111
|
-
}
|
|
112
|
-
}
|
|
113
|
-
}
|
|
114
|
-
}
|
|
115
|
-
```
|
|
116
|
-
|
|
117
|
-
> Both env vars match the shipped patch's defaults, so **they can be omitted entirely** —
|
|
118
|
-
> writing them out just makes the route explicit. The API key does not have to live in Zed:
|
|
119
|
-
> store it in `~/.dsh/.credentials.yaml` (`DEEPSEEK_API_KEY`) and the dsh credentials
|
|
120
|
-
> service resolves it; the launcher also falls back to a running `dsh web` process's key.
|
|
121
|
-
|
|
122
|
-
Optional: pin the panel's default config options (all still changeable in the panel):
|
|
123
|
-
|
|
124
|
-
```jsonc
|
|
125
|
-
"dsh-acp-enhanced": {
|
|
126
|
-
// ...the type/command/args/env above...
|
|
127
|
-
"default_config_options": {
|
|
128
|
-
"model": "deepseek-official/deepseek-v4-flash",
|
|
129
|
-
"plan_mode": false,
|
|
130
|
-
"reasoning_effort": "high"
|
|
131
|
-
},
|
|
132
|
-
"favorite_config_option_values": {
|
|
133
|
-
"model": ["deepseek-official/deepseek-v4-flash", "deepseek-official/deepseek-v4-pro"]
|
|
134
|
-
}
|
|
135
|
-
}
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
#### Extended: route through an OpenAI-Responses gateway (e.g. a company model gateway)
|
|
139
|
-
|
|
140
|
-
Same install path; only the env values change to the provider/model the gateway exposes
|
|
141
|
-
plus the key env var it requires:
|
|
142
|
-
|
|
143
|
-
```jsonc
|
|
144
|
-
"dsh-acp-enhanced": {
|
|
145
|
-
"type": "custom",
|
|
146
|
-
"command": "/bin/bash",
|
|
147
|
-
"args": ["/absolute/path/to/dsh-acp-enhanced/scripts/dsh-acp-zed.sh"],
|
|
148
|
-
"env": {
|
|
149
|
-
"DSH_ACP_PROVIDER": "<gateway-provider-id>", // provider id exposed by the gateway
|
|
150
|
-
"DSH_ACP_MODEL": "<gateway-model-id>", // model id exposed by the gateway
|
|
151
|
-
"<KEY_ENV_NAME>": "<key>" // the key env var the gateway reads
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
> `<KEY_ENV_NAME>` can also be omitted and the key stored in
|
|
157
|
-
> `~/.dsh/.credentials.yaml` instead.
|
|
158
|
-
|
|
159
|
-
Zed hot-reloads settings. Open the **AI Agent panel** (`Cmd+Shift+A`) → pick
|
|
160
|
-
**dsh-acp-enhanced** in the agent selector → send your first message: replies stream in
|
|
161
|
-
real time, the status bar shows context usage, the panel exposes Model / Permission preset
|
|
162
|
-
/ Plan mode options plus three modes, and the thread archive lists and resumes past
|
|
163
|
-
sessions.
|
|
164
|
-
|
|
165
|
-
Verify locally (no Zed needed):
|
|
166
|
-
|
|
167
|
-
```sh
|
|
168
|
-
node scripts/acp-client.mjs # official default route, no env; expect ALL CHECKS PASSED
|
|
169
|
-
DSH_ACP_PROVIDER=... DSH_ACP_MODEL=... node scripts/acp-client.mjs # only for a custom route
|
|
170
|
-
```
|
|
171
|
-
|
|
172
|
-
### Optional: route web_search through the same gateway
|
|
173
|
-
|
|
174
|
-
If the gateway implements the OpenAI Responses `web_search` server tool, you can route
|
|
175
|
-
search through it too (reusing the same credential). Install the sub-package and append
|
|
176
|
-
two blocks to the profile's `cordis.patch.yml`:
|
|
177
|
-
|
|
178
|
-
```sh
|
|
179
|
-
dsh plugin --profile acp-enhanced add dsh-web-search-openrouter
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
```yaml
|
|
183
|
-
- id: web
|
|
184
|
-
config:
|
|
185
|
-
searchProvider: <provider>
|
|
186
|
-
|
|
187
|
-
- insert:
|
|
188
|
-
- id: web-search-openrouter
|
|
189
|
-
name: 'dsh-web-search-openrouter'
|
|
190
|
-
config:
|
|
191
|
-
enabled: true
|
|
192
|
-
baseURL: http://<gateway-host>:<port>/v1
|
|
193
|
-
model: <your-model-id>
|
|
194
|
-
apiKeyEnv: <KEY_ENV_NAME>
|
|
195
|
-
```
|
|
196
|
-
|
|
197
|
-
## Troubleshooting
|
|
198
|
-
|
|
199
|
-
| Symptom | Fix |
|
|
200
|
-
|---|---|
|
|
201
|
-
| `exec: dsh: not found` (status 127) | Use the shipped `dsh-acp-zed.sh` launcher (locates node/dsh itself) |
|
|
202
|
-
| `no API key for provider route "xxx"` | Write `~/.dsh/.credentials.yaml`, or set `env.DEEPSEEK_API_KEY` on the agent_servers entry |
|
|
203
|
-
| Cannot switch models / context usage missing | A "phantom provider" route was picked; this bridge filters them by default (only `config.provider`'s models are advertised) — point the profile's provider at a real route |
|
|
204
|
-
| Need detailed diagnostics | `ACP_DEBUG=1 dsh --profile acp-enhanced` (stderr lifecycle trace) |
|
|
205
|
-
|
|
206
|
-
## Development
|
|
207
|
-
|
|
208
|
-
```sh
|
|
209
|
-
node scripts/acp-client.mjs # end-to-end smoke (needs an API key)
|
|
210
|
-
node scripts/acp-client-tools.mjs # client-tool tests (mocks Zed fs/terminal/elicitation/plan)
|
|
211
|
-
node scripts/acp-mcp-test.mjs # MCP mount test (no model calls)
|
|
212
|
-
node scripts/acp-smoke-keyless.mjs # keyless boot smoke (CI)
|
|
213
|
-
node scripts/acp-resume-test.mjs # session resume test
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
## Known limitations
|
|
217
|
-
|
|
218
|
-
Baseline prompts only (no image/audio attachments), no `additionalDirectories`, text
|
|
219
|
-
streams at block granularity, one in-flight prompt per session. MCP supports stdio and
|
|
220
|
-
streamable HTTP (legacy SSE / `acp` transports are not advertised).
|
|
221
|
-
`session/close` / `session/fork` / `session/resume` are not implemented (capabilities
|
|
222
|
-
undeclared, compliant clients will not call them); `session/delete` removes the persisted
|
|
223
|
-
directory directly because dsh persistence has no official delete API.
|