nexus-agentd 0.1.7 → 0.1.9

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,454 +1,230 @@
1
- # Agent Nexus Gateway
2
-
3
- [![CI](https://github.com/lumia1998/nexus-gateway/actions/workflows/ci.yml/badge.svg)](https://github.com/lumia1998/nexus-gateway/actions/workflows/ci.yml)
4
-
5
- `nexus-agentd` 是 Agent Nexus 的本地 Gateway。它在一台机器上统一管理 ACP 进程和远程 A2A
6
- Agent,并向 Koishi AgentNexus 或其他客户端提供 HTTP/SSE API。管理控制台使用 **Agent Nexus**
7
- 品牌,不依赖 CDN、前端框架或父仓库。
8
-
9
- 如果你从 Koishi 使用 Gateway,请先阅读配套插件的
10
- [安装与配置说明](https://github.com/lumia1998/koishi-plugin-agent-nexus#readme)。
11
-
12
- ## 快速开始
13
-
14
- 当前稳定版本已发布到 npm,推荐按下面的 npm 流程启动;如果要运行 GitHub 上尚未发布的分支代码,
15
- 再使用下方的源码部署方式。首次初始化、systemd 和 Agent 准备的完整说明见下文。
16
-
17
- ```bash
18
- NPM_CONFIG_PREFIX="$HOME/.local"
19
- npm install --global --prefix "$NPM_CONFIG_PREFIX" nexus-agentd@latest
20
- export PATH="$NPM_CONFIG_PREFIX/bin:$PATH"
21
- mkdir -p "$HOME/.config/agent-nexus" "$HOME/projects"
22
- nexus-agentd \
23
- --config "$HOME/.config/agent-nexus/nexus-agentd.json" \
24
- --host 0.0.0.0 \
25
- --port 8787 \
26
- --workspace "$HOME/projects"
27
- ```
28
-
29
- 当前仓库版本 `0.1.6` 已发布到 npm;可用 `npm view nexus-agentd version` 检查 registry 的 latest,
30
- 也可以将安装命令固定为 `nexus-agentd@0.1.6`。
31
-
32
- ## 安装与部署
33
-
34
- ### 运行要求
35
-
36
- - Node.js 20 或更高版本。
37
- - 一个明确的工作区目录。Gateway 只允许 Agent 访问 workspaceRoots 及其子目录。
38
- - 计划使用的 ACP CLI/Adapter 已安装,并且对运行 Gateway 的同一个操作系统用户可用。
39
- - LAN 部署需要在主机防火墙中限制 8787 端口来源;公网部署应放在 HTTPS/mTLS 反向代理或可信隧道后。
40
-
41
- Gateway 不会替你安装 Agent,也不会替你执行 OpenCode、Claude Code 或 Hermes 的登录命令;这些属于宿主机运维步骤。
42
-
43
- ### npm 包安装(已发布版本)
44
-
45
- `0.1.6` 已发布到 npm。目标版本尚未发布时,请使用下面的源码部署,或将本仓库打包后的 tarball 安装到目标机器。
46
-
47
- 发布状态可用 `npm view nexus-agentd version` 检查;生产环境需要可复现部署时,建议固定为 `nexus-agentd@0.1.6`。
48
-
49
- 生产环境建议使用专用的低权限系统用户,并把 npm 全局包安装到用户目录:
50
-
51
- ~~~bash
52
- NPM_CONFIG_PREFIX="$HOME/.local"
53
- npm install --global --prefix "$NPM_CONFIG_PREFIX" nexus-agentd@0.1.6
54
- export PATH="$NPM_CONFIG_PREFIX/bin:$PATH"
55
- ~~~
56
-
57
- 启动命令是 nexus-agentd,npm 包的 CLI 入口是 dist/cli.js。
58
-
59
- ### 首次初始化
60
-
61
- 首次启动时指定配置文件、监听地址和工作区:
62
-
63
- ~~~bash
64
- mkdir -p "$HOME/.config/agent-nexus" "$HOME/projects"
65
- nexus-agentd \
66
- --config "$HOME/.config/agent-nexus/nexus-agentd.json" \
67
- --host 0.0.0.0 \
68
- --port 8787 \
69
- --workspace "$HOME/projects"
70
- ~~~
71
-
72
- 首次启动后:
73
-
74
- 1. 打开终端打印的 http://<gateway-host>:8787/ui/。
75
- 2. 设置至少 12 位的 Console Password。
76
- 3. 在 API Keys 页面创建给 Koishi 或其他客户端使用的数据面 API Key。
77
- 4. 在 Workspaces 页面确认工作区 allowlist,在 Agents 页面检查 ACP/A2A Agent。
78
-
79
- Console Password 和 API Key 是两套凭证:前者只用于管理页面登录,后者只用于数据面 API。不要把 Console Password 填到 Koishi 插件的 gatewayKey。
80
-
81
- 配置已经存在时,--host、--port 和 --workspace 不会重新覆盖已有配置;后续启动只需要指定同一个 --config。
82
- 也可以通过 NEXUS_AGENTD_CONFIG 环境变量提供配置路径。
83
-
84
- ### systemd user service(可选)
85
-
86
- 仓库不内置 systemd unit。使用 npm 包时,可以创建 ~/.config/systemd/user/nexus-agentd.service:
87
-
88
- ~~~ini
89
- [Unit]
90
- Description=Nexus Agent Gateway
91
- After=network-online.target
92
- Wants=network-online.target
93
-
94
- [Service]
95
- Type=simple
96
- WorkingDirectory=%h/projects
97
- Environment=NODE_ENV=production
98
- Environment="PATH=%h/.local/bin:/usr/local/bin:/usr/bin:/bin"
99
- ExecStart=%h/.local/bin/nexus-agentd --config %h/.config/agent-nexus/nexus-agentd.json
100
- Restart=on-failure
101
- RestartSec=3
102
- TimeoutStopSec=20
103
- KillMode=mixed
104
- UMask=0077
105
-
106
- [Install]
107
- WantedBy=default.target
108
- ~~~
109
-
110
- 加载、启用和检查:
111
-
112
- ~~~bash
113
- systemctl --user daemon-reload
114
- systemctl --user enable --now nexus-agentd.service
115
- systemctl --user status nexus-agentd.service
116
- ~~~
117
-
118
- 常用运维命令:
119
-
120
- ~~~bash
121
- systemctl --user restart nexus-agentd.service
122
- journalctl --user -u nexus-agentd.service -n 100 --no-pager
123
- curl http://127.0.0.1:8787/health
124
- ~~~
125
-
126
- 如果使用 nvm、mise 或其他用户级 Node 安装方式,请把 unit 中的 PATH 改成实际值,否则 Gateway 可能能启动,但找不到 Agent CLI。
127
- 需要用户未登录时也自动启动时,可按发行版策略执行 loginctl enable-linger "$USER"。
128
-
129
- 如果按源码部署,把 unit 中的 `WorkingDirectory` 改成 Gateway 工作树,并将 `ExecStart` 改为实际 Node
130
- 绝对路径加上 `dist/cli.js`,例如:`/usr/bin/node %h/nexus-gateway/dist/cli.js --config
131
- %h/.config/agent-nexus/nexus-agentd.json`。不要在 systemd 中依赖交互式 Shell 的 nvm 初始化。
132
-
133
- ### 源码部署(开发分支或未发布版本)
134
-
135
- 源码部署适合当前仓库和尚未发布到 npm 的版本;生产环境请使用外部进程管理器负责守护,
136
- 不要把运行数据、Artifact 仓库或密钥放进 Git 工作树:
137
-
138
- ~~~bash
139
- git clone https://github.com/lumia1998/nexus-gateway.git
140
- cd nexus-gateway
141
- mkdir -p "$HOME/.config/agent-nexus" "$HOME/projects"
142
- npm ci
143
- npm run build
144
- node dist/cli.js \
145
- --config "$HOME/.config/agent-nexus/nexus-agentd.json" \
146
- --host 0.0.0.0 \
147
- --port 8787 \
148
- --workspace "$HOME/projects"
149
- ~~~
150
-
151
- 源码仓库没有 Docker、PM2 或 systemd 配置,需要由宿主机的进程管理器负责守护和重启。
152
-
153
- ## 认证边界
154
-
155
- 控制面和数据面使用不同凭证:
156
-
157
- - Console Password 只用于管理员登录。服务端以 scrypt 哈希保存,登录后只下发
158
- `HttpOnly; SameSite=Strict` Cookie,浏览器不保存密码。
159
- - API Key 只用于 `/v1/agents` 和 `/v1/sessions/*`。Key 可以命名、限制为全部或指定 Agent、
160
- 停用、删除、重生成和按需 reveal。
161
- - Key 自动生成为 `nx_sk_...`;也可设置至少 16 位的自定义值。
162
- - 为支持管理员按需 reveal,API Key 可恢复地保存在权限为 `0600` 的配置文件中,不会出现在
163
- 普通配置响应或日志里。
164
-
165
- 旧配置中的 `authToken` 会继续作为名为 `Legacy Access Key` 的全 Agent 数据面 Key 工作。它不会
166
- 被当成 Console Password。升级后第一次打开 WebUI 会要求单独设置管理员密码,原有 Agent 和
167
- Workspace 配置保持不变。
168
-
169
- ## WebUI
170
-
171
- 固定侧栏有总览、运行记录、智能体、工作区、文件、API 密钥和运行设置七个主页面。管理员菜单位于侧栏底部,
172
- 提供 Light / Dark / System 主题、修改密码和退出登录。
173
-
174
- - Overview 只显示真实 Agent、Ready 和当前内存 Session 数量。
175
- - 运行记录把当前任务和历史任务分开显示,记录用户原始任务、真实运行阶段、状态、结果摘要、
176
- 耗时和产物;每 5 秒自动刷新,也可查看完整详情。
177
- - Agents 支持本地 ACP 与远程 A2A;readiness 每 20 秒自动刷新,也可手动刷新。
178
- - Workspaces 管理 ACP 的 realpath allowlist;A2A 不使用本地 Workspace。
179
- - 文件页面在 allowlist 内浏览、上传、下载、新建目录、重命名和删除文件,并可生成临时公开链接。
180
- 发布操作只复制选定文件,不会把工作区映射成公开静态目录。
181
- - API Keys 显示真实状态和最后使用时间,并提供独立的显式 reveal 操作。
182
- - 运行设置可以直接修改 Session 空闲有效期、ACP 单次任务超时和清理任务周期,保存后立即热生效。
183
- 默认值分别是 24 小时、30 分钟和 60 秒;A2A 请求超时在每个 Agent 的编辑页单独设置,默认 60 秒、
184
- 最大 30 分钟。
185
-
186
- ## Agent 协议
187
-
188
- ### ACP
189
-
190
- | Driver | 默认入口 |
191
- |---|---|
192
- | `opencode` | `opencode acp` |
193
- | `claude` | `claude-agent-acp` |
194
- | `codex` | `codex-acp` |
195
- | `pi` | `pi-acp` |
196
- | `openclaw` | `openclaw acp` |
197
- | `hermes` | `hermes acp` |
198
-
199
- Claude Code、Codex、Pi 通常需要对应 Adapter:
200
-
201
- ```bash
202
- npm install -g \
203
- @agentclientprotocol/claude-agent-acp \
204
- @agentclientprotocol/codex-acp \
205
- pi-acp
206
- ```
207
-
208
- `command`、`args`、`inheritEnv` 和 `env` 是仅可在本机配置文件修改的高级字段,WebUI 不接受这些
209
- 字段。Workspace 在启动进程前经过 `realpath` 边界校验。
210
-
211
- ### OpenCode、Claude Code 和 Hermes 的宿主机准备
212
-
213
- 这三个 Agent 不需要修改 Gateway 源码,差异只在宿主机的可执行文件、ACP 入口和登录环境:
214
-
215
- | Agent | Gateway 默认启动命令 | readiness 检查 | 宿主机要求 |
216
- | --- | --- | --- | --- |
217
- | OpenCode | opencode acp | opencode --version | 安装 OpenCode CLI;使用原生 ACP。 |
218
- | Claude Code(CC) | claude-agent-acp | claude-agent-acp --version | 安装 @agentclientprotocol/claude-agent-acp,并准备 Claude Code 登录环境。 |
219
- | Hermes | hermes acp | hermes acp --check | 安装 Hermes CLI;使用原生 ACP。 |
220
-
221
- Claude Code、Codex 和 Pi 的常用 Adapter 可以一起安装:
222
-
223
- ~~~bash
224
- npm install --global --prefix "$HOME/.local" \
225
- @agentclientprotocol/claude-agent-acp \
226
- @agentclientprotocol/codex-acp \
227
- pi-acp
228
- ~~~
229
-
230
- OpenCode 和 Hermes 请按各自项目的官方方式安装。Gateway 不执行 OpenCode、Claude Code 或 Hermes 的登录命令;登录必须在运行 nexus-agentd 的同一个操作系统用户环境中完成。
231
-
232
- 可在同一用户的交互式 Shell 中检查:
233
-
234
- ~~~bash
235
- command -v opencode && opencode --version
236
- command -v claude-agent-acp && claude-agent-acp --version
237
- command -v hermes && hermes acp --check
238
- ~~~
239
-
240
- 如果命令在交互式 Shell 中可用、在 systemd 中不可用,检查 unit 的 PATH、HOME、XDG_CONFIG_HOME 和登录凭据。某个 Agent 未安装或检查失败不会影响其他 Agent。
241
-
242
- 一个最小的 ACP 配置示例(可在 WebUI 的 Agents 页面创建,也可写入本机配置文件):
243
-
244
- ~~~json
245
- {
246
- "workspaceRoots": ["/home/lumia/projects"],
247
- "agents": {
248
- "opencode": {
249
- "protocol": "acp",
250
- "driver": "opencode",
251
- "name": "OpenCode",
252
- "workspace": "/home/lumia/projects"
253
- },
254
- "claude": {
255
- "protocol": "acp",
256
- "driver": "claude",
257
- "name": "Claude Code",
258
- "workspace": "/home/lumia/projects"
259
- },
260
- "hermes": {
261
- "protocol": "acp",
262
- "driver": "hermes",
263
- "name": "Hermes",
264
- "workspace": "/home/lumia/projects"
265
- }
266
- }
267
- }
268
- ~~~
269
-
270
- `workspace` 必须位于 `workspaceRoots` 之下;如果只通过 WebUI 配置,Gateway 会校验并保存这些字段。
271
-
272
- Gateway 会在每个 Agent Session 的首次请求前自动注入一段 Agent Nexus 交互规范,提醒 Agent 在需要
273
- 用户选择、确认、支付或补充信息时使用 ACP elicitation/A2A `input-required`,不要只输出普通文本问题。
274
- 这段规范不需要为 OpenCode、Claude Code 或 Hermes 手工重复配置。若某个 Agent 还需要额外规则,可在 Agent
275
- 配置中增加 `instructions`;它会在内置规范之后追加,并限制为最多 32768 个字符。提示词注入只是行为约定,
276
- Agent 仍必须实际支持相应的 ACP/A2A/MCP 用户输入机制,Gateway 不会把普通文本自动猜成等待状态。
277
-
278
- ### A2A
279
-
280
- A2A 使用官方 `@a2a-js/sdk` 客户端,通过完整的 Agent Card URL 发现名称、能力和实际调用地址,
281
- 支持 JSON-RPC / HTTP+JSON 传输、流式消息(SDK 自动回退为非流式)、任务状态、Artifacts 和取消。
282
- 首选传输可设为 `auto`、`jsonrpc` 或 `http-json`;可配置无认证、Bearer 或自定义 Header。私有网段
283
- 和局域网 URL 不会被禁止。
284
-
285
- ```json
286
- {
287
- "protocol": "a2a",
288
- "name": "Research Agent",
289
- "instructions": "需要用户确认时保持任务等待,并使用 Agent 的 input-required 能力。",
290
- "agentCardUrl": "http://192.168.1.20:8080/.well-known/agent-card.json",
291
- "preferredTransport": "auto",
292
- "auth": {
293
- "type": "bearer",
294
- "value": "env:RESEARCH_AGENT_TOKEN"
295
- },
296
- "timeoutMs": 60000
297
- }
298
- ```
299
-
300
- 旧配置中的 `agentUrl` 仍按“服务根地址 + `/.well-known/agent-card.json`”方式发现 Card,无需手工
301
- 迁移;在 WebUI 中保存一次后会写入新的 `agentCardUrl` 字段。
302
-
303
- ## 配置
304
-
305
- 推荐从首次启动生成的待初始化配置开始。完整示例见
306
- [`nexus-agentd.example.json`](./nexus-agentd.example.json)。数值和数组字段会严格校验,错误配置
307
- 会在启动或原子热重载前被拒绝,不再静默截断或忽略错误类型。
308
-
309
- 常用资源限制:
310
-
311
- ```json
312
- {
313
- "maxRequestBytes": 1048576,
314
- "maxAttachmentBytes": 33554432,
315
- "artifactStoragePath": "./artifacts",
316
- "maxArtifactBytes": 536870912,
317
- "maxArtifactStorageBytes": 4294967296,
318
- "maxPublishedArtifacts": 4096,
319
- "maxConcurrentArtifactPublishes": 4,
320
- "artifactTtlMs": 86400000,
321
- "requestTimeoutMs": 30000,
322
- "promptTimeoutMs": 1800000,
323
- "cleanupIntervalMs": 60000,
324
- "maxSessions": 64,
325
- "maxSseConnections": 128,
326
- "maxConnections": 256,
327
- "sessionTtlMs": 86400000
328
- }
329
- ```
330
-
1
+ # Agent Nexus Gateway
2
+
3
+ [![CI](https://github.com/lumia1998/nexus-gateway/actions/workflows/ci.yml/badge.svg)](https://github.com/lumia1998/nexus-gateway/actions/workflows/ci.yml)
4
+
5
+ `nexus-agentd` 是 Agent Nexus 的本地 Gateway。它在一台机器上统一管理 ACP 进程和远程 A2A
6
+ Agent,并向 Koishi AgentNexus 或其他客户端提供 HTTP/SSE API。管理控制台使用 **Agent Nexus**
7
+ 品牌,不依赖 CDN、前端框架或父仓库。
8
+
9
+ ## 启动
10
+
11
+ ```bash
12
+ npm install -g nexus-agentd
13
+ nexus-agentd
14
+ ```
15
+
16
+ 首次启动会创建 `./nexus-agentd.json`,默认监听 `127.0.0.1:8787`。打开打印出的 WebUI 地址,
17
+ 设置至少 12 位的 Console Password,然后登录。新安装不会自动创建 API Key;在控制台的
18
+ **API Keys** 页面按实际客户端需要创建。
19
+
20
+ 局域网使用时显式监听所有网卡:
21
+
22
+ ```bash
23
+ mkdir -p /data/repos
24
+ nexus-agentd --host 0.0.0.0 --workspace /data/repos
25
+ ```
26
+
27
+ `0.0.0.0` 是受支持的监听地址。CLI 会同时打印本机和检测到的 LAN IPv4 WebUI 地址。
28
+ `--host`、`--port` 和 `--workspace` 只用于首次创建配置;配置存在后直接指定文件:
29
+
30
+ ```bash
31
+ nexus-agentd --config /etc/agent-nexus/nexus-agentd.json
32
+ ```
33
+
34
+ ## 认证边界
35
+
36
+ 控制面和数据面使用不同凭证:
37
+
38
+ - Console Password 只用于管理员登录。服务端以 scrypt 哈希保存,登录后只下发
39
+ `HttpOnly; SameSite=Strict` Cookie,浏览器不保存密码。
40
+ - API Key 只用于 `/v1/agents` 和 `/v1/sessions/*`。Key 可以命名、限制为全部或指定 Agent、
41
+ 停用、删除、重生成和按需 reveal。
42
+ - Key 自动生成为 `nx_sk_...`;也可设置至少 16 位的自定义值。
43
+ - 为支持管理员按需 reveal,API Key 可恢复地保存在权限为 `0600` 的配置文件中,不会出现在
44
+ 普通配置响应或日志里。
45
+
46
+ 旧配置中的 `authToken` 会继续作为名为 `Legacy Access Key` 的全 Agent 数据面 Key 工作。它不会
47
+ 被当成 Console Password。升级后第一次打开 WebUI 会要求单独设置管理员密码,原有 Agent 和
48
+ Workspace 配置保持不变。
49
+
50
+ ## WebUI
51
+
52
+ 固定侧栏有总览、运行记录、智能体、工作区、API 密钥和运行设置六个主页面。管理员菜单位于侧栏底部,
53
+ 提供 Light / Dark / System 主题、修改密码和退出登录。
54
+
55
+ - Overview 只显示真实 Agent、Ready 和当前内存 Session 数量。
56
+ - 运行记录把当前任务和历史任务分开显示,记录用户原始任务、真实运行阶段、状态、结果摘要、
57
+ 耗时和产物;每 5 秒自动刷新,也可查看完整详情。
58
+ - Agents 支持本地 ACP 与远程 A2A;readiness 每 20 秒自动刷新,也可手动刷新。
59
+ - Workspaces 管理 ACP 的 realpath allowlist;A2A 不使用本地 Workspace。
60
+ - API Keys 显示真实状态和最后使用时间,并提供独立的显式 reveal 操作。
61
+ - 运行设置可以直接修改 Session 空闲有效期、ACP 单次任务超时和清理任务周期,保存后立即热生效。
62
+ 默认值分别是 24 小时、30 分钟和 60 秒;A2A 请求超时在每个 Agent 的编辑页单独设置,默认 60 秒、
63
+ 最大 30 分钟。
64
+
65
+ ## Agent 协议
66
+
67
+ ### ACP
68
+
69
+ | Driver | 默认入口 |
70
+ |---|---|
71
+ | `opencode` | `opencode acp` |
72
+ | `claude` | `claude-agent-acp` |
73
+ | `codex` | `codex-acp` |
74
+ | `pi` | `pi-acp` |
75
+ | `openclaw` | `openclaw acp` |
76
+ | `hermes` | `hermes acp` |
77
+
78
+ Claude Code、Codex、Pi 通常需要对应 Adapter:
79
+
80
+ ```bash
81
+ npm install -g \
82
+ @agentclientprotocol/claude-agent-acp \
83
+ @agentclientprotocol/codex-acp \
84
+ pi-acp
85
+ ```
86
+
87
+ `command`、`args`、`inheritEnv` 和 `env` 是仅可在本机配置文件修改的高级字段,WebUI 不接受这些
88
+ 字段。Workspace 在启动进程前经过 `realpath` 边界校验。
89
+
90
+ ### A2A
91
+
92
+ A2A 使用官方 `@a2a-js/sdk` 客户端,通过完整的 Agent Card URL 发现名称、能力和实际调用地址,
93
+ 支持 JSON-RPC / HTTP+JSON 传输、流式消息(SDK 自动回退为非流式)、任务状态、Artifacts 和取消。
94
+ 首选传输可设为 `auto`、`jsonrpc` 或 `http-json`;可配置无认证、Bearer 或自定义 Header。私有网段
95
+ 和局域网 URL 不会被禁止。
96
+
97
+ ```json
98
+ {
99
+ "protocol": "a2a",
100
+ "name": "Research Agent",
101
+ "agentCardUrl": "http://192.168.1.20:8080/.well-known/agent-card.json",
102
+ "preferredTransport": "auto",
103
+ "auth": {
104
+ "type": "bearer",
105
+ "value": "env:RESEARCH_AGENT_TOKEN"
106
+ },
107
+ "timeoutMs": 60000
108
+ }
109
+ ```
110
+
111
+ 旧配置中的 `agentUrl` 仍按“服务根地址 + `/.well-known/agent-card.json`”方式发现 Card,无需手工
112
+ 迁移;在 WebUI 中保存一次后会写入新的 `agentCardUrl` 字段。
113
+
114
+ ## 配置
115
+
116
+ 推荐从首次启动生成的待初始化配置开始。完整示例见
117
+ [`nexus-agentd.example.json`](./nexus-agentd.example.json)。数值和数组字段会严格校验,错误配置
118
+ 会在启动或原子热重载前被拒绝,不再静默截断或忽略错误类型。
119
+
120
+ 常用资源限制:
121
+
122
+ ```json
123
+ {
124
+ "maxRequestBytes": 1048576,
125
+ "maxAttachmentBytes": 33554432,
126
+ "requestTimeoutMs": 30000,
127
+ "promptTimeoutMs": 1800000,
128
+ "cleanupIntervalMs": 60000,
129
+ "maxSessions": 64,
130
+ "maxSseConnections": 128,
131
+ "maxConnections": 256,
132
+ "sessionTtlMs": 86400000
133
+ }
134
+ ```
135
+
331
136
  输入附件通过 Session 临时保存,默认单个文件最多 16 MiB、单个 Session 最多 32 MiB、最多 16 个文件;
332
- HTTP 上传总上限由 `maxAttachmentBytes` 控制,默认 32 MiB,允许调整到 64 MiB。Session 释放时附件也会
333
- 一起清理。ACP 会优先使用 Agent 声明支持的 image/audio/embeddedContext 能力,否则为 Agent 提供受限的
137
+ HTTP 上传总上限由 `maxAttachmentBytes` 控制,默认 32 MiB,允许调整到 64 MiB。Session 释放时附件也会
138
+ 一起清理。ACP 会优先使用 Agent 声明支持的 image/audio/embeddedContext 能力,否则为 Agent 提供受限的
334
139
  `file://` resource link;A2A 则以带文件名和媒体类型的二进制 Part 发送。
335
140
 
336
- 输出文件发布由 Gateway 自己的 `artifactStoragePath` 管理,默认单文件上限 512 MiB、链接有效期
337
- 24 小时。上传和复制均使用流,不把文件编码进 JSON;公开 URL 使用 256 位随机 token,过期文件由
338
- 后台清理。ACP/A2A 返回的内联二进制 Artifact 也会先落入该仓库,再在 Session 响应中改为 URL。
339
-
340
- ### 多轮输入与确认
341
-
342
- ACP elicitation、ACP permission request 和 A2A `input_required` 都会让 Session 进入等待状态,并在
343
- Session 响应的 `pendingRequest` 中返回等待提示和可选项。客户端只需重复调用同一个
344
- `POST /v1/sessions/:id/message`:
345
-
346
- ~~~text
347
- POST /v1/sessions/:id/message
348
- {"message":"第一个"}
349
- ~~~
350
-
351
- Gateway 会复用原来的协议 Session/Task/Context,不会创建新任务。Agent 可以在下一轮再次进入
352
- `input_required`,因此套餐选择、堂食方式、取餐时间和支付完成可以组成一条连续流程。需要表达业务
353
- 步骤时,可在 `pendingRequest` 中提供可选的 `step`、`inputType` 和 JSON-safe `metadata`;这些字段
354
- 不应放入密钥或其他敏感信息。支付完成消息仍必须由上游 MCP 根据订单/支付状态核验,不能只信任用户文本。
355
-
356
- 对 ACP Agent,Gateway 会在 Session 首次 prompt 前注入内置交互规范;对 A2A Agent,则把同一规范放在首个
357
- 用户消息的前缀中。由于 A2A/ACP 的 system-message 能力在不同 Agent 实现中并不统一,这是一种兼容性更好的
358
- 宿主提示方式。它不能替代 Agent 对 elicitation 或 `input-required` 的实现:Agent 必须真正发起协议级等待,
359
- Gateway 才能暂停 Session 并在用户回复后继续。
360
-
361
- API Key 与 A2A 认证值支持 `env:VAR`。Console Password 哈希由 WebUI 管理,不要手工生成或把
362
- 旧 `authToken` 复制到该字段。
363
-
364
- 运行记录保存在配置文件同目录的 `nexus-agentd-runs.json` sidecar 中,默认最多保留 1000 条。
365
- 记录文件使用 `0600` 权限和原子替换;进行中的任务若遇到 Gateway 重启,会在下次启动时标记为
366
- “已中断/失败”,而不会一直显示为运行中。
367
-
368
- ## API
369
-
370
- 匿名端点:
371
-
372
- ```text
373
- GET /health
374
- GET /v1/bootstrap/status
375
- POST /v1/bootstrap/initialize
376
- GET /v1/admin/auth/status
377
- POST /v1/admin/auth/login
378
- POST /v1/admin/auth/logout
379
- ```
380
-
381
- 管理员 Cookie 端点:
382
-
383
- ```text
384
- GET /v1/admin/overview
385
- GET /v1/admin/config
386
- GET /v1/admin/agents
387
- GET /v1/admin/runs
388
- GET /v1/admin/runs/:id
389
- PUT /v1/admin/agents/:id
390
- DELETE /v1/admin/agents/:id
391
- PUT /v1/admin/config/workspace-roots
392
- PUT /v1/admin/config/runtime
393
- PUT /v1/admin/password
394
- GET /v1/admin/api-keys
395
- POST /v1/admin/api-keys
396
- PATCH /v1/admin/api-keys/:id
397
- DELETE /v1/admin/api-keys/:id
398
- POST /v1/admin/api-keys/:id/reveal
399
- POST /v1/admin/api-keys/:id/regenerate
400
- GET /v1/admin/files/roots
401
- GET /v1/admin/files
402
- GET /v1/admin/files/content
403
- PUT /v1/admin/files/content
404
- DELETE /v1/admin/files/content
405
- POST /v1/admin/files/directory
406
- POST /v1/admin/files/move
407
- POST /v1/admin/files/publish
408
- ```
409
-
141
+ ACP Session 还支持显式发布工作区文件。发布接口只接受 realpath 仍位于该 Session 工作区中的普通文件,
142
+ 拒绝目录、路径穿越和符号链接逃逸,单个文件最多 12 MiB。响应将文件作为 Session Artifact 返回;不会
143
+ 暴露宿主机绝对路径。
144
+
145
+ API Key 与 A2A 认证值支持 `env:VAR`。Console Password 哈希由 WebUI 管理,不要手工生成或把
146
+ 旧 `authToken` 复制到该字段。
147
+
148
+ 运行记录保存在配置文件同目录的 `nexus-agentd-runs.json` sidecar 中,默认最多保留 1000 条。
149
+ 记录文件使用 `0600` 权限和原子替换;进行中的任务若遇到 Gateway 重启,会在下次启动时标记为
150
+ “已中断/失败”,而不会一直显示为运行中。
151
+
152
+ ## API
153
+
154
+ 匿名端点:
155
+
156
+ ```text
157
+ GET /health
158
+ GET /v1/bootstrap/status
159
+ POST /v1/bootstrap/initialize
160
+ GET /v1/admin/auth/status
161
+ POST /v1/admin/auth/login
162
+ POST /v1/admin/auth/logout
163
+ ```
164
+
165
+ 管理员 Cookie 端点:
166
+
167
+ ```text
168
+ GET /v1/admin/overview
169
+ GET /v1/admin/config
170
+ GET /v1/admin/agents
171
+ GET /v1/admin/runs
172
+ GET /v1/admin/runs/:id
173
+ PUT /v1/admin/agents/:id
174
+ DELETE /v1/admin/agents/:id
175
+ PUT /v1/admin/config/workspace-roots
176
+ PUT /v1/admin/config/runtime
177
+ PUT /v1/admin/password
178
+ GET /v1/admin/api-keys
179
+ POST /v1/admin/api-keys
180
+ PATCH /v1/admin/api-keys/:id
181
+ DELETE /v1/admin/api-keys/:id
182
+ POST /v1/admin/api-keys/:id/reveal
183
+ POST /v1/admin/api-keys/:id/regenerate
184
+ ```
185
+
410
186
  Bearer API Key 数据面:
411
187
 
412
188
  ```text
189
+ GET /v1/meta
413
190
  GET /v1/agents
414
191
  POST /v1/sessions
415
192
  GET /v1/sessions/:id
193
+ DELETE /v1/sessions/:id
416
194
  POST /v1/sessions/:id/attachments
417
195
  POST /v1/sessions/:id/message
196
+ POST /v1/sessions/:id/requests/:requestId/resolve
197
+ POST /v1/sessions/:id/artifacts/publish
418
198
  POST /v1/sessions/:id/cancel
419
199
  GET /v1/sessions/:id/events
420
- GET /v1/sessions/:id/files
421
- GET /v1/sessions/:id/files/content
422
- POST /v1/sessions/:id/files/publish
423
200
  ```
424
201
 
425
- `GET /v1/artifacts/:token/:expiresAt/:name` 是匿名下载端点;它只接受发布操作生成的不可猜测 token,并在 TTL
426
- 到期后返回 404。该端点不支持目录列举,也不能据此访问原工作区。
427
-
428
- API Key 的 Agent scope 在 Agent inventory、Session 创建和后续 Session 操作上都会检查;Session
429
- 还绑定创建它的 Key,其他 Key 即使拥有同一 Agent scope 也不能读取或控制该 Session。
430
- 运行记录接口仅接受管理员 Cookie,数据面 API Key 无权读取。
431
-
432
- ## 局域网安全
433
-
434
- - 默认仍只监听 localhost;需要 LAN 时显式使用 `--host 0.0.0.0`,并用主机防火墙限制来源。
435
- - LAN 上的纯 HTTP 为兼容 Cookie 默认不设置 `Secure`;跨不可信网络应放在 HTTPS/mTLS 反向代理
436
- 或可信隧道后,并将 `secureAdminCookies` 设为 `true`。
437
- - 管理写操作要求同源 `Origin`,Cookie 使用 `SameSite=Strict`;登录和无效 API Key 有失败限速。
438
- - File Browser 的所有路径都在 realpath 后重新校验工作区边界;Session 发布还同时校验 API Key
439
- scope 与 Session 所有权。公开链接应只发送给预期接收者。
440
- - 不直接暴露公网。使用专用低权限系统账号运行 Gateway。
441
- - 配置更新使用 `0600` 临时文件校验后原子替换;Secret 不进入普通响应和结构化错误日志。
442
-
443
- ## 验证
444
-
445
- ```bash
446
- npm test
447
- npm run typecheck
448
- npm run build
449
- npm pack --dry-run --json
450
- ```
451
-
452
- ## License
453
-
454
- [MIT](./LICENSE)
202
+ `/v1/meta` 和 Session 响应包含 Gateway `instanceId`,客户端可识别进程重启。授权与输入通过精确的
203
+ `requestId` 解析;过期 ID 返回 `409`,不会误答后续请求。`DELETE /v1/sessions/:id` 会取消活动任务、
204
+ 释放 Agent 进程并移除内存 Session。
205
+
206
+ API Key 的 Agent scope 在 Agent inventory、Session 创建和后续 Session 操作上都会检查;Session
207
+ 还绑定创建它的 Key,其他 Key 即使拥有同一 Agent scope 也不能读取或控制该 Session。
208
+ 运行记录接口仅接受管理员 Cookie,数据面 API Key 无权读取。
209
+
210
+ ## 局域网安全
211
+
212
+ - 默认仍只监听 localhost;需要 LAN 时显式使用 `--host 0.0.0.0`,并用主机防火墙限制来源。
213
+ - LAN 上的纯 HTTP 为兼容 Cookie 默认不设置 `Secure`;跨不可信网络应放在 HTTPS/mTLS 反向代理
214
+ 或可信隧道后,并将 `secureAdminCookies` 设为 `true`。
215
+ - 管理写操作要求同源 `Origin`,Cookie 使用 `SameSite=Strict`;登录和无效 API Key 有失败限速。
216
+ - 不直接暴露公网。使用专用低权限系统账号运行 Gateway。
217
+ - 配置更新使用 `0600` 临时文件校验后原子替换;Secret 不进入普通响应和结构化错误日志。
218
+
219
+ ## 验证
220
+
221
+ ```bash
222
+ npm test
223
+ npm run typecheck
224
+ npm run build
225
+ npm pack --dry-run --json
226
+ ```
227
+
228
+ ## License
229
+
230
+ [MIT](./LICENSE)