Introduction

Much work in the DSH plugin ecosystem revolves around the collaboration between agents and the local environment. dsh-document-review targets a specific scenario: reviewing Markdown documents within DSH.

It renders Markdown in a local browser, allowing users to select text to add comments, suggest replacements, or suggest deletions. Once the agent reads these annotations, it modifies the source file using standard file editing tools. The following sections introduce its purpose, installation, and usage.

What is it

dsh-document-review is a DeepSeek Harness plugin maintained by yabo083, licensed under MIT, and requires Node >=20.

It supports reviewing individual Markdown files as well as entire directories. The browser review page renders Markdown in read-only mode and displays annotations in a sidebar; the page does not directly edit the Markdown source file.

Annotations are centrally stored in:

~/.dsh-document-review/annotations.jsonl

This is an append-only storage. Annotations include textQuote anchors and SHA-256 source file hashes for verifying staleness.

Core Features

First, let’s discuss its capabilities. This plugin provides the following capabilities:

  • Reviewing Markdown documents in a local browser.
  • Supporting the selection of text to add comments, suggest replacements, or suggest deletions.
  • Supporting the review of both individual Markdown files and entire directories.
  • Providing document_review_start, document_review_list, document_review_update, and document_review_stop tools.

In directory mode, it recursively lists .md/.markdown files, skipping node_modules, .git, and build artifact directories, handling a maximum of 500 files.

Regarding settings, it provides global settings and current workspace settings, layering over the cordis.yml configuration:

Defaults → cordis.yml → Global Settings → Workspace Settings

Global settings are persisted to:

~/.dsh-document-review/config.json

Current workspace settings are persisted to:

~/.dsh-document-review/workspace-configs.json

Regarding entry points, it provides a “Document Review” entry in the DSH sidebar Workspace row menu and exposes HTTP routes such as /api/v2/document-review/start for use by the GUI launcher.

Installation and Enablement

First, install the plugin:

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

If installing from a local checkout for development, specify the absolute path of cordis.yml first:

dsh web --patch /absolute/path/to/dsh-document-review/cordis.yml

You need to modify the path according to your checkout location.

After completing the above steps, you can open:

http://127.0.0.1:3080

Then ask the agent:

Review the document at /path/to/file.md word by word.

Alternatively, open the ⋯ menu in the Workspace row and select “Document Review” to access the review page.

Typical Usage

Single File Flow:

  1. Open the DSH Web page.
  2. Tell the agent the Markdown path to review, for example:
Review the document at /path/to/file.md word by word.
  1. Select a segment of text in the rendered document.
  2. Choose to add a comment, suggest a replacement, or suggest a deletion.
  3. The annotations appear in the sidebar; once the agent reads them, it applies the modifications using standard file editing tools.

Directory Flow:

  1. Pass the directory path to document_review_start.
  2. The page lists the .md/.markdown files in the directory; it recursively lists them, skipping node_modules, .git, and build artifact directories, handling a maximum of 500 files.
  3. Open each document one by one and add annotations.

If you need to be launched by a GUI launcher, you can call the HTTP route:

POST /api/v2/document-review/start

Suitable Scenarios and Notes

Suitable Scenarios:

  • Reviewing a single Markdown file within a DSH workflow.
  • Reviewing multiple Markdown documents within a directory.
  • Humans are responsible for annotation, while the agent is responsible for reading the annotations and executing the modifications.

Notes:

  • The browser review page does not directly edit the Markdown source file; modifications are applied by the agent using standard file editing tools.
  • The plugin runs with the permissions of the current dsh process; you should check the source code and license before installing.
  • Directory mode has a file count limit, handling a maximum of 500 files and skipping node_modules, .git, and build artifact directories.
  • The runtime environment requires Node >=20.

Resources

GitHub:

https://github.com/yabo083/dsh-document-review

Plugin Directory Page:

https://www.skillhub.cn/plugins/yabo083/dsh-document-review