mirror of
https://github.com/deepseek-ai/deepseek-harness
synced 2026-08-15 21:04:50 +00:00
ecb8aa5b8e
Every packages/*/* README now carries a canonical '## Known Limitations and
Deferred Work' section: condensed, evidence-backed bullets for consumer-visible
gaps (unimplemented features, platform caveats, MVP cuts) and consciously
postponed work (TODO/FIXME/XXX markers, RFC deferrals still open). The ten
pre-existing ad-hoc variants ('What is NOT here (TODO)', 'Deferred',
'Limitations (MVP)', 'Known limitations (tracked TODOs)', ...) are normalized
into the canonical heading.
A new doc-sync gate, scripts/verify-readme-limitations.ts, enforces the shape:
exactly one limitations-like heading per package README, byte-equal to the
canonical h2, with at least one bullet; near-miss headings fail so variants
cannot creep back. Packages with genuinely nothing to declare (dsh-brand,
dsh-timeout, dsh-subagent-mock, dsh-app-boot) are whitelisted in the script and
must NOT carry the section; whitelist entries are validated against the scanned
package set so a rename fails loud.
Wired into the doc-sync chain (package.json) and the run-gates doc-sync leaf
set; the standing rule lands in packages/AGENTS.md and the adding-a-package
cookbook; decision record in
docs/rfc/implemented/process/2026-07-10-readme-known-limitations-gate.md
(RFC index regenerated).
Also fixes two stale '(deferred)' markers claiming dsh-compact-basic is
unimplemented (the dsh-compact seam README's package table and the seam's
module doc comment).
@deepseek-ai/dsh-user-interaction
Abstract user-interaction seam. It owns ctx.userInteraction, the service a model-facing tool or permission plugin uses when it needs to pause work and ask the human for a decision.
Service: UserInteractionService (ctx key: userInteraction)
Public API
ctx.userInteraction.registerProvider(provider): () => voidRegister the UI-side provider. Only one provider may be active in a context; disposal unregisters it.ctx.userInteraction.ask(request): Promise<AskUserQuestionAnswer>Ask the active provider and wait for the answer.
Key Types
AskUserQuestionRequest—{ questions: [{ id, question, header?, options?, multiSelect? }], agent?, signal? }.AskUserQuestionOption—{ label, description? }.AskUserQuestionAnswer—{ answers: [{ id, selected, custom? }] }.UserInteractionProvider— UI implementation withask(request).UserInteractionError—HarnessErrorsubclass with codes such asEMPTY_QUESTIONS,NO_PROVIDER,DUPLICATE_PROVIDER, andASK_ABORTED.
When an answer includes custom, selected is empty; custom text is an override rather than a supplement to selected choices.
Role
This is the interface package. Model-facing consumers such as @deepseek-ai/dsh-tool-ask-user depend on this seam; UI front doors such as the stdio-agent readline module and the acp bridge provide the provider. The loop stays unchanged: a tool call simply awaits a promise, and the tool result resumes the normal agent loop.
Known Limitations and Deferred Work
- One provider per context — there is no routing or fan-out to multiple UIs; a second registration throws
DUPLICATE_PROVIDER, and with none registeredask()throwsNO_PROVIDERrather than degrading. - The vocabulary is the question-form shape only — selectable options plus optional custom text; richer interaction shapes (file pickers, diff-preview confirmations) have no seam vocabulary yet.