Files

T

Tianyi Cui 34aabc4183 test(sdk): snapshot suite over the SDK path; docs for the SDK stack

- examples/jsonrpc-agent gains its first snapshot suite (sdk.snapshot.ts):
  the real dsh-jsonrpc-agent runtime driven through the real dsh-sdk-client,
  keyless llm-replay behind a new cordis.snapshot.yml overlay; three recorded
  scenarios (text turn, bash tool, spawn subagent) pin the notification
  stream, the SDK turn result, and the persisted parent+child session logs.
- Bilingual READMEs for dsh-sdk-protocol / dsh-sdk-client / dsh-subagent-sdk;
  sdk/ and subagent/ group tables extended; dsh-jsonrpc README points at the
  extracted protocol package; Agent Note (en+zh) owns the decision.
- The proposed make-jsonrpc-directional note is updated for the transport's
  new home and its second (client) consumer.
- Model Experience sentence allowlist entries for the two client-side
  packages; module graph + config catalog regenerated; i18n pairings
  recorded. doc-sync passes 24/24.

2026-07-27 04:37:23 +08:00

4.9 KiB

Raw Blame History

@deepseek-ai/dsh-sdk-client

English | 中文

以子进程方式驱动 DeepSeek Harness 运行时、走 stdio JSON-RPC 的 TypeScript 客户端 SDK——Python SDK（deepseek-harness）的设计孪生，共享同一个运行时对端、协议与分层：DeepSeekHarness 是高层回合 API，HarnessClient 是低层协议客户端。纯库：不在任何 Cordis 上下文注册；它所生成的运行时进程是一个完整 harness，其组成由自己的 cordis.yml 决定。

与 Python SDK 不同，启动规格完全显式（command/args）：本包面向仓库近旁的 TypeScript 消费者——dsh-subagent-sdk 后端、测试、自动化——它们知道自己要启动哪个运行时。捆绑运行时解析（寻找打包可执行文件）仍归 Python 发行版负责。

DeepSeekHarness

import { DeepSeekHarness } from '@deepseek-ai/dsh-sdk-client'

await using harness = new DeepSeekHarness({
  launch: { command: 'node', args: ['lib/bin.js', 'cordis.yml'] },
  provider: 'deepseek',
  model: 'deepseek-v4-flash',
})
const result = await harness.run('say hi')
console.log(result.status, result.finalResponse)

子进程在首次使用时惰性启动，并在多次 run() 之间持续归实例所有；必须 close()（或 await using），子进程才总能被收割。start() 记忆化 initialize 握手（cwd + provider/model 路由）；握手失败会关闭运行时并复位，后续调用可以重试。session(id?) 打开具名或全新的会话句柄；run(input, { sessionId?, onNotification? }) 发送一个 prompt 回合，在配对的 session.finished 到达时尘埃落定，返回 TurnResult：status（按部署映射的 ok/error）、结构化 reason（TurnEndReason）、finalResponse（最后一条助手消息文本），以及该会话树内按线序观察到的全部 session.event 封套与原始通知。模型层失败是 status: 'error' 的结果，绝不是拒绝；拒绝意味着传输丢失、超时或协议违例。

HarnessClient

回合 API 之下的协议客户端：显式 start()/initialize()/prompt()/request()/close()，外加通知订阅。subscribe(filter?) 返回 NotificationSubscription（可等待的 next()、非阻塞 tryNext()、异步迭代）；subscribeSessionTree(id) 把范围限定到一个会话及从 subagent.started 血缘边发现的后代——运行时对上下文内每个会话都发通知，范围限定在客户端完成，与 Python SDK 完全一致。错误表面有类型：JsonRpcResponseError（线上错误响应，保留 code/data）、RequestTimeoutError（配置的时限已到；线上没有取消方法，请求在服务端继续运行直到 close）、SdkProtocolError（响应超出文档化协议）、TransportClosedError（运行时已消失——消息携带退出码与有界 stderr 尾部）。

close() 先请求协议 shutdown（受 shutdownTimeoutMs 约束，默认 1000 毫秒），然后走共享的 stdin-EOF → SIGTERM → SIGKILL 处置阶梯（disposeEofGraceMs 默认 6000，disposeGraceMs 默认 3000）直到进程真正退出。幂等，已关闭的客户端拒绝复用。

HarnessClientOptions.env 给定时整体替换子环境（undefined 原样继承父环境）；凭据策略归调用方——dsh-subagent-subprocess 的 buildChildEnv 是面向隔离启动的先擦除后注入助手。

测试

免密钥单元测试通过真实 stdio 驱动一个脚本化伪运行时子进程（tests/fake-runtime.ts，纯协议、环境变量脚本化）：回合循环、会话树范围限定、超时/死亡/畸形响应表面、处置阶梯。SDK 快照套件经由 llm-replay 免密钥地通过本客户端驱动真实 dsh-jsonrpc-agent 运行时，钉住通知流、回合结果与持久化日志；DSH_SNAPSHOT=record 对真实 API 重录。

Model Experience

None, as this is a client-process library; the model runs in the spawned runtime, whose experience is owned by the plugins its cordis.yml composes.

KV Cache effect

None; this package neither assembles nor sends a provider request.

Known Limitations and Deferred Work

无捆绑运行时解析 —— 调用方显式指定运行时可执行文件；打包可执行文件的发现留在 Python 侧，直到出现 TypeScript 发行版消费者。
无回合中取消 —— 线上没有 prompt 取消方法；放弃回合意味着关闭运行时（见协议的 Known Limitations）。
每会话同时只有一个在途 prompt —— 服务端规则，本客户端将其呈现为 JsonRpcResponseError；相互独立的会话可在同一运行时上并发。
client→server 通知与 server→client 请求在线两端都未实现；传输层为未来审批流保留了承载能力。

4.9 KiB Raw Blame History Unescape Escape