md-redline

👁 npm version

Inline-Überprüfungskommentare für Markdown-Spezifikationen, Prompts und Designdokumente.

Markieren Sie Text in einem gerenderten Dokument, hinterlassen Sie Kommentare, und Ihr KI-Agent kann diese direkt lesen und bearbeiten. Kommentare werden als unsichtbare HTML-Marker direkt in der .md-Datei gespeichert. Keine Sidecar-Dateien, keine Datenbank, kein externer Dienst. Die Markdown-Datei bleibt die Quelle der Wahrheit.

Mit dem integrierten MCP-Server kann Ihr Agent während einer Aufgabe eine Überprüfung anfordern und pausieren, bis Sie auf Überprüfung senden klicken. Sie hinterlassen Ihr Feedback, der Agent macht dort weiter, wo er aufgehört hat. Kein Kopieren und Einfügen, kein Kontextwechsel.

👁 md-redline screenshot

Sehen Sie sich den vollständigen Überprüfungs-Workflow in 30 Sekunden an:

https://github.com/user-attachments/assets/7f493201-3aca-489c-86f0-3a7df454f693

Funktioniert mit Claude Code, Claude Desktop, Codex CLI, Gemini CLI und jedem anderen MCP-Client, der stdio-Server unterstützt. Wie Sean Grove in specs are the new code argumentiert, werden Spezifikationen zur primären Arbeitseinheit in der agentenbasierten Entwicklung. mdr bietet diesem Workflow Überprüfungswerkzeuge, die dem Code-Review nahekommen.

Schnellstart

Voraussetzung: Node 20 oder neuer.

npx md-redline /path/to/spec.md

Dies startet bei Bedarf die lokale App und öffnet sie in Ihrem Browser.

Oder global installieren:

npm install -g md-redline
mdr /path/to/spec.md # Open a file
mdr /path/to/dir # Open a directory
mdr --stop # Stop the running server

md-redline funktioniert auch als Alias für mdr.

Related MCP server: mdshare

MCP-Einrichtung

Registrieren Sie den MCP-Server bei Ihrem Agenten, damit dieser während einer Aufgabe Überprüfungen anfordern kann.

Claude Code oder Claude Desktop

mdr mcp install # register with both clients (default)
mdr mcp install --claude-code # just Claude Code (via `claude mcp add`)
mdr mcp install --claude-desktop # just Claude Desktop (JSON config file)

Codex CLI

codex mcp add md-redline -- mdr mcp

Gemini CLI

gemini mcp add --scope user md-redline mdr mcp

Das Flag --scope user ist wichtig. Gemini verwendet standardmäßig einen projektbezogenen Bereich, der mdr nur für das aktuelle Verzeichnis registriert.

Andere MCP-Clients

Fügen Sie diesen Servereintrag zur MCP-Konfigurationsdatei Ihres Clients hinzu:

{
 "mcpServers": {
 "md-redline": {
 "command": "mdr",
 "args": ["mcp"]
 }
 }
}

Voraussetzung: mdr muss sich in Ihrem PATH befinden (z. B. via npm install -g md-redline). Wenn Ihr Client Unterprozesse startet, ohne den PATH Ihrer Shell zu übernehmen, verwenden Sie den absoluten Pfad von which mdr als command-Wert.

Überprüfungs-Workflow

Mit MCP (empfohlen)

Sobald registriert, bitten Sie Ihren Agenten, eine Überprüfung anzufordern:

"Lass mich docs/specs/feature-x.md in mdr überprüfen, bevor du fortfährst."

Der Agent ruft mdr_request_review auf, mdr öffnet die Datei, Sie markieren Text und hinterlassen Kommentare, dann klicken Sie auf Überprüfung senden. Der Agent erhält Ihr Feedback als strukturierten Prompt und beginnt mit der Bearbeitung Ihrer Kommentare. Die Überprüfung erfolgt auf Anfrage. Der Agent pausiert nur, wenn Sie ihn darum bitten.

Ohne MCP

1. Öffnen Sie eine Markdown-Datei mit mdr /pfad/zu/spec.md.

2. Markieren Sie Text und hinterlassen Sie Inline-Kommentare.

3. Kopieren Sie den Übergabe-Prompt.

4. Fügen Sie den Prompt in Ihren KI-Agenten ein.

5. Der Agent bearbeitet die Datei, geht auf das Feedback ein und entfernt die von ihm bearbeiteten Kommentar-Marker.

6. Überprüfen Sie das Ergebnis in der Diff-Ansicht.

Optional: Workflow auflösen

Aktivieren Sie den Auflösungsmodus in den Einstellungen für die menschliche Überprüfung mit expliziten open (offen) und resolved (gelöst) Zuständen.

Für wen ist das gedacht?

• Personen, die Spezifikationen, Prompts oder Designdokumente lokal schreiben mit dateibasierten KI-Agenten

• Teams, die Dokumente überprüfen, bevor sie committet oder für eine breitere Überprüfung versendet werden

• Jeden in einer Mensch + Agent Bearbeitungsschleife, der strukturiertes Inline-Feedback in einfachen Dateien wünscht

Nicht-Ziele

• Kein kollaboratives Multi-User-Bearbeitungstool.

• Kein Ersatz für GitHub PR-Reviews (verwenden Sie diese, sobald die Datei in Git ist).

• Nicht für nicht vertrauenswürdige Inhalte konzipiert. Dies ist ein lokales Entwicklungstool für Ihre eigenen Dateien.

Wie Kommentare gespeichert werden

Kommentare werden als unsichtbare HTML-Marker direkt im Markdown gespeichert, unmittelbar vor dem Text, auf den sie sich beziehen, sodass sowohl Menschen als auch Agenten mit derselben Datei arbeiten können.

Some text <!-- @comment{
 "id":"uuid",
 "anchor":"highlighted text",
 "text":"Rewrite this section to be clearer.",
 "author":"User",
 "timestamp":"2026-03-26T12:00:00.000Z",
 "replies":[]
} -->highlighted text continues here.

Dies macht Feedback:

• für KI-Agenten über ein einfaches Dateilesen sichtbar

• portabel mit der Markdown-Datei

• unsichtbar in normalen Renderern (GitHub, VS Code Vorschau)

Funktionen

Überprüfung und Kommentierung

• Inline-Kommentare, die an gerendertem Text verankert sind, einschließlich überlappender Kommentare

• Threaded-Antworten und optionale open / resolved Überprüfungszustände

• Anpassbare Anker mit Ziehgriffen

• Gerenderte, Roh- und Diff-Ansichten

• Kopieren von Übergabe-Prompts für eine oder mehrere Dateien

Navigation und Bearbeitung

• Multi-Tab-Bearbeitung mit Sitzungspersistenz und Tab-Kontextmenüs

• Dateiexplorer, zuletzt verwendete Dateien und nativer OS-Dateiauswahldialog

• Suchen im Dokument (Cmd+F) mit Treffernavigation

• Inhaltsverzeichnis mit Scroll-Spy

• Befehlspalette (Cmd+K), Tastaturkürzel und Einstellungsbereich (Cmd+,)

• Größenveränderbare Bereiche und Rechtsklick-Kontextmenüs

Rendering und Integrationen

• Echtzeit-Neuladen via SSE bei externen Dateiänderungen

• Mermaid-Diagramm-Rendering mit kommentierbarem Text

• Lokale Bildeinbettungen und anklickbare Links zwischen Markdown-Dateien

• Anpassbare Kommentarvorlagen

• 8 Themen: Light, Dark, Sepia, Nord, Solarized, GitHub, Rosé Pine, Catppuccin

Unterstützte Plattformen

• macOS: unterstützt

• Linux: unterstützt; System-Dateiauswahldialog erfordert zenity

• Windows: unterstützt; System-Dateiauswahldialog verwendet PowerShell

Berechtigungen

Standardmäßig kann md-redline jede Markdown-Datei in Ihrem Home-Verzeichnis lesen. Wenn Sie mdr zum ersten Mal ausführen (oder zum ersten Mal nach einem Upgrade von einer Version ohne das Trusted-Roots-Feature), wird Ihr Home-Ordner einer Liste vertrauenswürdiger Wurzeln unter ~/.md-redline.json hinzugefügt. Dateien außerhalb Ihres Home-Verzeichnisses (/tmp, gemountete Volumes, Systempfade) erfordern beim ersten Öffnen eine explizite Berechtigungserteilung über den OS-Ordnerauswahldialog. Erteilte Ordner werden über Neustarts hinweg gespeichert.

Um stattdessen das strikte Pro-Ordner-Modell zu verwenden, führen Sie nach der Installation einmal mdr --restrict aus. Dies erstellt eine ~/.md-redline.json ohne Standardvertrauen, und Sie erteilen für jeden Ordner explizit Berechtigungen, wenn Sie zum ersten Mal eine Datei darin öffnen.

Dateispeicherungen verwenden atomares Schreiben-dann-Umbenennen und eine mtime-basierte Konflikterkennung, um Datenverlust durch gleichzeitige Bearbeitungen zu verhindern. Mermaid SVG-Ausgabe wird vor dem Rendern durch DOMPurify bereinigt. Führen Sie md-redline nur in Umgebungen aus, denen Sie vertrauen.

Entwicklung

Aus dem Quellcode

git clone https://github.com/dejuknow/md-redline.git
cd md-redline
npm install
npm run dev

Öffnen Sie die lokale URL, die von Vite ausgegeben wird (normalerweise http://localhost:5188).

Skripte

npm run dev # Start dev server
npm run lint # Lint
npm test # Production build + unit tests
npm run test:e2e # Playwright E2E tests
npm run build # Production build

Agenten-Eval

Der Eval-Harness testet, ob KI-Agenten Inline-Kommentare korrekt lesen, bearbeiten und entfernen.

• npm run eval:dry validiert Eval-Fixtures

• npm run eval führt den vollständigen Eval-Harness aus

• Siehe eval/README.md für Details

Architektur

bin/md-redline CLI entry point (invoked as `mdr` or `md-redline`)
server/index.ts Hono server for file I/O, browsing, SSE, and local integrations
src/App.tsx Main application shell
src/components/ Viewer, sidebar, raw view, diff view, TOC, explorer, settings, etc.
src/hooks/ State, persistence, selection, file watching, drag handles, tabs
src/lib/comment-parser.ts Inline comment parsing and mutation helpers
src/markdown/pipeline.ts Markdown rendering pipeline
eval/ Eval harness for agent behavior against inline comments
e2e/ Playwright end-to-end coverage

Lizenz

MIT

Maintenance

Resources

• NPM Package
• GitHub Repository
Need Help?Related Servers

Tools

• mdr_request_reviewA