yabo083/dsh-document-review

DeepSeek Harness 插件:在本地浏览器中审阅 Markdown 文档,支持注释、替换和删除建议。支持单个文件和整个目录。

Project Overview项目介绍

This is a native DeepSeek Harness (DSH) plugin built exclusively for DSH, designed to enable collaborative word-by-word review of local Markdown documents in a local browser. It can be installed quickly via the official DSH CLI command dsh plugin --profile web add dsh-document-review, or patched for development using dsh web --patch /path/to/dsh-document-review/cordis.yml. After installation, it adds a dedicated "Document Review" menu entry to the DSH sidebar, and registers four model-facing tools for managing review sessions. To use it, DSH agents start a session for a single Markdown file or an entire directory of Markdown files, and get back a local browser URL to open for review.

When reviewing, users can select text in the rendered document to add comments, suggest replacements, or mark text for deletion. The browser interface never edits the original Markdown source file; all annotations are stored in a central append-only JSONL file at ~/.dsh-document-review/annotations.jsonl, so annotations from any file across the local machine are accessible to the DSH agent in a single tool call. The plugin supports layered configuration that blends default values, base config from cordis.yml, global user settings, and per-workspace overrides to meet different review needs. Users can adjust port preferences, idle timeouts, ignored directories, and other settings directly from an in-page settings dialog.

This plugin is adapted from the opencode-document-review project, re-wrapping the same core HTTP server and security model for DSH instead of OpenCode. It follows strict security practices: the HTTP server binds only to 127.0.0.1, validates loopback Host and same-origin requests, uses a random write token, and disables CORS to prevent unauthorized access. All development dependencies can be installed via npm install, and the project is built with npm run build, which compiles both host TypeScript code and client React JSX code into usable bundles. The plugin is released under the permissive open-source MIT license.

这是一款专为 DeepSeek Harness (DSH) 开发的原生文档审阅插件,支持用户在本地浏览器中逐字审阅本地任意位置的 Markdown 文档。用户可以在渲染后的文档里选中文本,添加评论、建议文本替换或标记删除,所有批注不会修改源 Markdown 文件,统一存储在中央追加存储区内,全机任意位置的文档批注都可被 DSH Agent 一键读取。

DSH Agent 经常需要编写和编辑架构文档、ADR、README、项目计划等各类 Markdown 内容,这款插件填补了 DSH 生态此前没有专用文档审阅批注工具的空白。典型工作流为:Agent 启动审阅会话打开文档到本地浏览器,用户完成审阅批注后,Agent 读取所有批注,再通过常规文件编辑工具应用修改。

插件提供四个面向模型的工具,支持启动/停止会话、列出全部批注、更新批注状态,可通过 DSH 官方命令一键安装,配置遵循 DSH 插件规范,支持全局和工作区两级设置分层覆盖。插件采用 MIT 许可开源,HTTP 服务仅绑定本地回环地址,安全配置完善,不用担心非法访问问题。

Pre-install check安装前体检Compatibility · Security兼容性 · 安全性 1 warning1 项注意
  • Only 2 stars - very few users, little community feedback星标只有 2,几乎没人在用,遇到问题缺少社区反馈
DSH walks through these 9 checksDSH 会逐条核对这 9 项

Compatibility兼容性

  • DSH, Node, OS and profile requirementsDSH 版本 / Node 版本 / 操作系统 / profile 是否满足要求
  • External dependencies and runtimes (Electron / Python / Docker, ...)外部依赖与运行时(Electron / Python / Docker 等)是否齐备
  • Conflicts with installed plugins: command names, skill / tool names, ports, duplicate MCP registration与已装插件是否冲突:命令名、skill / tool 重名、端口占用、重复 MCP 注册

Security安全性

  • Repo matches the facts registered here; archived or abandoned?仓库是否与页面登记一致,是否归档或长期停更
  • Safety of preinstall / install / postinstall and install.sh / setup.ps1preinstall / install / postinstall 与 install.sh、setup.ps1 是否安全
  • curl|bash, download-then-execute, obfuscation, unrelated domains → stop immediatelycurl|bash、下载即执行、混淆代码、无关域名 → 立刻停止
  • Typosquatting or unmaintained packages among the new dependencies新增依赖里有没有 typosquatting 或无人维护的包
  • Requested permissions vs. what the feature actually needs申请了哪些权限、是否超出功能所需(filesystem / network / shell / clipboard)
  • Any sudo / admin requirement, plus uninstall and rollback是否要求 sudo / 管理员权限,以及卸载与回滚方式

Anything uncertain must be marked unknown with a note on how to confirm it. This site's signal screen is a static snapshot, not a security audit.拿不准的必须标「未知」并说明要我怎么确认。本站的信号筛查是静态快照,不能替代安全审计。

Or use CLI install (for developers)或使用命令行安装(适合开发者)

CLI Install命令行安装

dsh plugin --profile web add dsh-document-review

把 yabo083/dsh-document-review 加入你的 DSH 配置(web profile)即可启用。

READMEREADME

dsh-document-review

A DeepSeek Harness plugin for reviewing Markdown documents in a local browser — word by word.

Select text in the rendered document to add a comment, suggest a replacement, or suggest deletion. The browser never edits the Markdown source; annotations are stored in one central append-only store at ~/.dsh-document-review/annotations.jsonl, so annotations on files anywhere on the machine — inside or outside the workspace — are all visible to the agent with a single tool call.

Adapted from opencode-document-review — the same review core (HTTP server, security model), wrapped as DSH model-facing tools instead of OpenCode tools, with annotations consolidated into a central store.

Why

DSH agents author and edit Markdown a lot — architecture docs, ADRs, READMEs, plans. "Review this document word by word" is a natural request, but DSH had no plugin for it (confirmed: no document-review/annotation plugin in the market as of 2026-08). This plugin fills that gap.

The agent opens the document in a local browser; the human reviews and annotates; the agent reads the annotations back and applies changes through its normal file-editing tools.

Tools

All four tools are registered on ctx.tools and become model-facing:

Tool Purpose
document_review_start Start or reuse a local review session for a Markdown file or directory (directory mode reviews every .md file inside). Returns the browser URL.
document_review_list Read review annotations (open/pending by default, or all). Without path, returns every annotation across all documents on the machine — the single call the agent needs after "审查完了你看下". Includes source-hash staleness. In directory mode, summarizes every document.
document_review_update Mark a comment (resolved/open) or suggestion (accepted/rejected/pending) as handled.
document_review_stop Stop the local review session. Annotations remain in the central store.

Settings

Configuration follows the official DSH plugin pattern: export a Schemastery Config schema, configure from cordis.yml (per-entry config: block), and additionally register the same schema as a DSH settings namespace (document-review) for runtime overrides.

Showing the opening section of the README — the full document lives in the repository以上为 README 开头摘要,完整文档在仓库内 · View the full README on GitHub →在 GitHub 查看完整 README →

← 上一个 Prev dsh-win-fable-report 下一个 Next dshmarketplace-cli →