Markdown Review

Markdown Review ist eine local-first-MCP-Apps-Oberfläche zum Prüfen von gerendertem Markdown, ohne eine zweite, editierbare Kopie des Dokuments zu erzeugen. Wählen Sie eine Passage aus, stellen Sie zeilenverankertes Feedback in die Warteschlange und übermitteln Sie die vollständige Prüfung in einem einzigen Vorgang an einen Coding-Agenten. Codex App ist der erste ausgelieferte interaktive Host; die Kernverträge, der Zustand und die Oberfläche sind bewusst hostneutral gehalten, damit künftige Claude-, pi-, Terminal- und Tauri-Adapter ergänzt werden können.

Status: frühe Entwicklung. Codex App ist der ausgelieferte interaktive Host; die wiederverwendbare UI und der MCP-Transport folgen dem MCP-Apps-Standard, sodass weitere Host-Adapter hinzugefügt werden können, ohne den Prüfkern neu zu schreiben.

Was es bietet

• Eine Vollbild-Markdown-Vorschau im GitHub-Stil im Seitenbereich.

• Normale Textauswahl und -kopie, gefolgt von einer kompakten +-Aktion für Feedback.

• Inline-Kommentarmarkierungen, nummeriert mit #1, #2 und so weiter.

• Eine Prüf-Warteschlange, die alle Kommentare gemeinsam übermittelt, um widersprüchliche Änderungen zu vermeiden.

• Referenzen zwischen eingereihten Kommentaren mit #N; für wörtlichen Text schreiben Sie \#N oder `#N`.

• Rendern relativer lokaler PNGs mit begrenztem, privatem Chunk-Transport.

• Automatische Prüfung, nachdem Codex ein Markdown-Dokument erstellt oder wesentlich bearbeitet hat.

Die Markdown-Quelle ist immer maßgeblich. Die Komponente ist eine reine Leseoberfläche; nur Codex bearbeitet die Quelldatei mit seinen normalen Dateisystemwerkzeugen.

Related MCP server: md-annotate

So funktioniert es

local .md file
    │
    ├── open_markdown_review ──► sanitized rendered component (private UI payload)
    │                                  │
    │                                  └── queued, line-anchored comments
    │                                                   │
    └◄──────────── Codex edits the original file ◄──────┘
                              one batch message

Der MCP-Server ist bewusst schmal gehalten:

1. open_markdown_review validiert und rendert einen absoluten .md- oder .markdown-Pfad.

2. Nur für die Komponente bestimmte Werkzeuge hydrieren das gerenderte Dokument und streamen freigegebene lokale PNGs in begrenzten Blöcken.

3. Das für das Modell sichtbare Werkzeugergebnis enthält Dateimetadaten, nicht das vollständige Dokument. Der gerenderte Inhalt wird privat an die Komponente übermittelt.

4. Die Skill-Anleitung erklärt, wie Codex das Prüf-Feedback interpretiert und das zugrunde liegende Markdown sicher ändert.

Genau diese Trennung ist der Grund, warum das Projekt MCP umfasst: Der Server verbindet einen Codex-Werkzeugaufruf mit einer vertrauenswürdigen interaktiven Komponente. Eine statische HTML-Datei allein kann die ausgewählte Quelldatei weder empfangen, strukturierte Prüf-Kommentare an die aktive Aufgabe zurückgeben noch diese Kontextgrenze aufrechterhalten.

Die Implementierung ist in hostneutrale TypeScript-Workspaces aufgeteilt. contracts validiert jede Grenze, core verwaltet den reinen Prüf-Zustand, markdown-node liest und rendert lokale Dateien, und review-ui wird über schmale Dokument-, Übermittlungs-, Darstellungs- und Zustands-Ports angebunden. host-mcp-apps stellt eine standardkonforme Laufzeit bereit, deren Standardübermittlungen strukturiertes JSON sindstrukturiert ist; die Codex-Browser-Komposition fügt explizit den prägnanten $markdown-review-Formatter hinzu. Eine optionale window.openai-Kompatibilität für Widget-Zustände bleibt isoliert. Eine künftige Tauri-Shell kann Verträge, Kern und UI wiederverwenden und sprach-spezifische IPC-Ports liefern; nicht verfügbar ist noch keine Tauri-Anwendung enthalten.

Host-Unterstützung

Noch nicht ausgebucht Adapter und Folgemaßnahmen zur Browser-Abnahme werden in ROADMAP.md nachverfolgt.

Installation aus dem Repository-Marketplace

Voraussetzungen:

• Codex in der ChatGPT-Desktop-App mit Unterstützung für Plugins.

• Node.js 22 oder neuer, verfügbar als node.

• Die codex-CLI zum Hinzufügen der Marketplace-Quelle.

Fügen Sie dieses Repository als Marketplace hinzu:

codex plugin marketplace add tjs-w/markdown-review --ref main

Starten Sie die Desktop-App neu, öffnen Sie das Plugin-Verzeichnis, wählen Sie Markdown Review und installieren Sie das Plugin. Starten Sie nach der Installation eine neue Aufgabe, damit die Aufgabe die Tze- og Tool-Registrierung des Plugins erhält.

So aktualisieren Sie eine bestehende Installation:

codex plugin marketplace upgrade markdown-review

Starten Sie die Desktop-App neu und starten Sie nach einem Upgrade eine neue Aufgabe. Bestehende Aufgaben behalten die Werkzeug- und Skill-Registrierungen, mit denen sie gestartet wurdeffentlich.

Verwendung

Bitten Sie Codex, einen absoluten Markdown-Pfad zu öffnen:

Open /absolute/path/to/document.md for Markdown review.

Innerhalb der Prüfung:

1. Wählen Sie Text aus und kopieren Sie ihn bei Bedarf ganz normal.

2. Verwenden Sie die +-Aktion der Auswahl, um das direkte Inline-Textfeld zu öffnen.

3. Drücken Sie Eingabe, um den Kommentar in die Warteschlange; Umschalt+Eingabe für eine neue Zeile.

4. Referenzieren Sie einen früheren eingereihten Kommentar mit #1, #2 und so weiter.

5. Wählen Sie Submit aus, sobald die Prüf-Runde abgeschlossen ist.

Nach einer erfolgreichen Übermittlung wird die Warteschlange geleert und die nächste Runde beginnt wieder bei #1. Es gibt bewusst keine Einzel-Übermittlung: Die Bündelung gibt Codex ein kohärentes Überarbeitungsziel und reduziert Konflikte in der Quelle.

Lokale Entwicklung

git clone https://github.com/tjs-w/markdown-review.git
cd markdown-review
bun install --frozen-lockfile
bun run verify

Entwicklung und CI verwenden die festgelegte Bun-1.4-Toolchain. Installierte Plugins benötigen kein Bun: dem Repository liegt ein lesbares Node-kompatibles server.cjs sowie minfizierte Browser-Bundles bei. Nach Änderungen an Typscript-Quelltext neu bauen:

bun run build

Starten Sie die Browser-Harness gegen eine Markdown-Datei für UI-ABBelt au:

bun run browser:harness -- /absolute/path/to/document.md

Setzen Sie (MARKDOWN_REVIEW_PREVIEW_COMPZER=1`, um den Feedback-Editor im Harness automatisch öffnen.

Um dieses Checkout als lokalen Marktplatz zu testen, fügen Sie sein absolutes Verzeichnis hinzu:

codex plugin marketplace add /absolute/path/to/markdown-review

Danach starten Sie die Desktop-AppAa neu und installieren das Plugin aus der lokalenMarktplatz-Quelle.

Sicherheits- undDatenschutzgrenzen

• Die Komponente kann die Markdown-Datei nicht schreiben.

• Gerendertes HTML wird bereinigt, bevor es die Komponente erreicht.

• Remote e, absolute und Dateien außerhalb des Verzeichnisses werden nicht geladen.

• Es werden nur relative PNG-Pfade innerhalb des Verzeichnisses der Markdown-Datei unterstützt.

• Die Komponenten-Ressource deklariert keine Netzwerk- oder Remote-Ressourcen-Domänen.

• Eine Markdown-Datei ist auf 2 MiB begrenzt.

• Eine Prüfung unterstützt höchstens 8 PNGs, 5 MiB pro Bild und insges 12 MiB, mit decodierter Größ en- und Pixel-Grenz

• Der Zugriff auf die Komponente erfolgt über undeutliche, ablaufende Fähigkeiten für Prüf-Sissions. Sitzungen gleiten zwei Stunden und sind begrenzt durch einen LRU mit sechs-Sitzungen und einem 72-MiB-Pufferkache.

• Bildbytes und SHA-256-Digests werden als Schnappschuss in der Sitzung abgelegt, sodass später manche nein laufendes Review verändern können.

• Vollständiger Dokumentinhalt und Bildblöcke liegen in model-sichtbareen strukturierten Ausgaben, nicht nur privaten Metadaten.

Prüfen Sie nur Dateien, die Sie vertrauen losen. Kommentare, die die Komponente zurückgegeben, werden als ztiertes Benutzer-Feedback behandeltundnicht als Anweisungen eingebedded the Prüf-Dokumente.

Projektstruktur

Wait, now I panicked in mid-table. Let me finish properly. I'll produce a valid table with the full set I planned. Need to avoid weird. OK.

I'll finalize the response now cleanly — no# Markdown Review

Markdown Review ist eine local-first-MCP-Apps-Oberfläche zum Prüfen von gerendertem Markdown, ohne eine zweite, editierbare Kopie des Dokuments zu erzeugen. Wählen Sie eine Passage aus, reihen Sie zeilenverankertes Feedback in die Warteschlange ein und übermitteln Sie die vollständige Prüfung im Stapel an einen Coding-Agenten. Codex App ist der erste ausgelieferte interaktive Host; die Kernverträge, der Zustand und die UI sind bewusst hostneutral gehalten, damit künftige Claude-, pi-, Terminal- und Tauri-Adapter ergänzt werden können.

Status: frühe Entwicklung. Codex App ist der ausgelieferte interaktive Host; die wiederverwendbare UI und der MCP-Transport folgen dem MCP-Apps-Standard, sodass weitere Host-Adapter hinzugefügt werden können, ohne den Review-Kern neu zu schreiben.

Was es bietet

• Eine Vollbild-Markdown-Vorschau im GitHub-Stil im Seitenpanel.

• Normale Textauswahl und Kopieren, gefolgt von einer kompakten +-Aktion für Feedback.

• Inline-Kommentarmarkierungen, nummeriert mit #1, #2 und so weiter.

• Eine Review-Warteschlange, die alle Kommentare gemeinsam übermittelt, um Konflikte zwischen Änderungen zu vermeiden.

• Referenzen zwischen eingereihten Kommentaren mit #N; für wörtlichen Text schreiben Sie \#N oder `#N`.

• Relative, lokale PNG-Renderung mit begrenztem, privatem Chunk-Transport.

• Automatische Prüfung, nachdem Codex ein Markdown-Dokument erstellt oder wesentlich bearbeitet hat.

Die Markdown-Quelle ist immer maßgeblich. Die Komponente ist eine reine Leseoberfläche; nur Codex bearbeitet die Quelldatei mit den normalen Dateisystem-Werkzeugen.

Funktionsweise

local .md file
    │
    ├── open_markdown_review ──► sanitized rendered component (private UI payload)
    │                                  │
    │                                  └── queued, line-anchored comments
    │                                                   │
    └◄──────────── Codex edits the original file ◄──────┘
                              one batch message

Der MCP-Server ist bewusst schmal gehalten:

1. open_markdown_review validiert und rendert einen absoluten .md- oder .markdown-Pfad.

2. Komponenteninterne Werkzeuge hydrieren das gerenderte Dokument und streamen freigegebene lokale PNGs in begrenzten Blöcken.

3. Das für das Modell sichtbare Werkzeug gehört ist beinhaltet Dateimetadaten, nicht das vollständige Dokument. Der gerenderte Inhalt wird direkt privat an die Komponente übermittelt.

4. Die- Anleitung ermittelt, wie Codex Review-Feedback interpretieren und die zugrunde liegende Markdown sicher ändern soll.

Diese Trennung begründet den Einsatz von MCP: Der Server verbindet einen Aufruf der Codex- Werkzeuge mit einer vertrauenswürdigen interaktiven Komponente. Eine statische HTML-Datei kann allein weder die ausgewählte Quelldatei empfangen, noch strukturierte Review-Kommentare an die aktive Aufgabe zurückgeben oder diese Kontextgrenze aufrechterhalten.

Die Implementierung ist in hostneutrale TypeScript-Pakete aufgeteilt. contracts validiert jede Grenze, core hält den reinen Review-Zustand, und markdown-node liest und rendert lokale Dateien; review-ui bindet an schmale Dokument-, Einreichungs-, Darstellungs- und Zustands-Ports. host-mcp-apps bietet eine MCP-Apps-kompatible Laufzeit, deren Standard-Einreichung strukturiertes JSON ist; die Codex-Browsermischung ergänzt explizit den prägnanten $markdown-review-Formatter. Die optionale Kompatibilität window.openai für Widget-Zustände bleibt isoliert. Eine zukünftige Tauri-Shell kann die Verträge, den Kern und die UI wiederverwenden und eigene IPC-Ports beisteuern.

Host-Unterstützung

Nicht freigegebene Adapter und Browser-Abnahmenacharbeiten sind in ROADMAP.md erfasst.

Installation über den Repository-Marketplace

Voraussetzungen:

• Codex in der ChatGPT-Desktop-App mit Plugin-Unterstützung.

• Node.js 22 oder neuere Version verfügbar als node.

• Die codex-CLI zum Hinzufügen der Marketplace-Quelle.

Fügen Sie das Repository als Marketplace hinzu:

codex plugin marketplace add tjs-w/markdown-review --ref main

Starten Sie die Desktop-App neu, öffnen Sie das Plugin-Verzeichnis, wählen Sie Markdown Review aus und installieren Sie das Plugin. Starten Sie nach der Installation eine neue Aufgabe, damit die Aufgabe die Plugin-Werkzeugregistrierung übernimmt.

So aktualisieren Sie eine bestehende Installation:

codex plugin marketplace upgrade markdown-review

Starten Sie nach einem Upgrade die Desktop-App neu und beginnen Sie eine neue Aufgabe. Bestehende Aufgaben behalten die Tool- und Skill-Registrierungen, mit denen sie gestartet wurden.

Verwendung

Lassen Sie Codex einen absoluten Markdown-Pfad öffnen:

"FragCifeste";

Open /absolute/path/to/document.md for Markdown review.

In der Review-Ansicht:

1. Wälen Sie Ttext aus und kpieren ihn bei Bedarf.

2. Verweden Sie die +-aktion der Auswahl, um werte den kompakten Inline-Komponisten.

3. Ündrücken Sie Diak Hi Eiter für neue Zeile.

4. affid onite für einen früheren warteschlange-Kommentar: #1, #2.

5. Sobald die Übersichts-Runde korrekt ist, wählen Submit.

Nach einer erfolgreichen Einreichung leert sich die Warteschlange und die nächste Runde beginnt wieder bei #1. Es ist bewusst kein Einzelnen-Senden vorgesehen: Durch die Bündelung erhält CodeClaude ein konkretes Überarbeitungsziel und Zustandsänderungen werden reduziert.

Ausbringungsentwicklung

git clone https://github.com/tjs-w/markdown-review.git
cd markdown-review
bun install --frozen-lockfile
bun run verify

Entwicklung und CI verwenden das Bun1.4- Tool- K.installiere Plugins benötigen kein Bun: das Repository checkt eine lesbare, Node-kompatible server.cjs sowie minifizierte Browser-Bundles ein. Nach einer TypeScript-Änderung rebuild bauen:

bun run build

Füren Sie die Browser-Referenz gegen eine Markdown-Datei für UI-Arbeiten:

bun run browser:harness -- /absolute/path/to/document.md

Setzen Sie MARKDOWN_REVIEW_PREVIEW_COMPOSER=1, um den Feedback-Komponisten im Harness automatisch zu öffnen.

Um diesen Checkout als lokalen Marketplace zu testen, fügen Sie dessen absolutes Verzeichnis hinzu:

codex plugin marketplace add /absolute/path/to/markdown-review

Starten Sie danach die Desktop-App neu und installieren Sie das Plugin ausder lokalen Marketplace-Quelle.

Sicherheits- undDatenschutzgrenzen

• Die Komponente kann die Markdown-Datei nicht beschreiben.

• Gerendertes HTML wird bereinigt, bevor es die Komponente erreicht.

• Fernbediene, absolute und außer Spielpfade werden nicht geladen.

• Es werden nur relative PNG-Pfade innerhalb des Markdown-Verzeichnisses unterstützt.

• Die Komponenten-Ressource deklariert keine Netzwerk- oder Remote-Ressourcen-Domains.

• Eine Markdown-Datei ist auf 2 MiB begrenzt.

• Ein Review unterstützt höchstens 8 PNGs, 5 MiB pro Bild und 12 MiB insgesamt, mit dekodierenden Abmessung und Pixel-Limits.

• Komponenten-Komponente Komponentenkapazitäten sind opaque und ablaufend. Sitzungen laufen zwei Stunden lang, begrenzt durch einen Sechs-Sitzungen-LRU und 72 MiB somee aggregate image cache.

• Bilddaten und SHA-256-Digests werden in der Sitzung gespeichert, sodass spätere Änderungen keine laufende Review verändern können.

• Vollständige Inhalte und Bilder-Chunks sind in Modell privaten ob beliebt; zu sehen sind strukturierte Ergebnisse.

Starten Sie nur Dateien, die Sie dem Plugin-Prozess sicher zugänglich machen möchten. Kommentare, die die Komponente zurückgibt, werden als zitiertes Feedback von Nutzerinnen behandelt, nicht als Anweisungen im zu prüfenden Dokument.

Projektstruktur

Fehlerbehebung

Die Dateien existieren, aber die Review- Funktion wird nicht registriert. Starten Sie die Desktop-App neu um neu. Neue Aufgaben gelten nur für neu skal.

Codex meldet einen unpfadwechsel. Lokalisiera verbundene Pfade; Plugin up/Reinstallieren, App neu starten.

Seitenleiste ist leer: Führung Bundle.,

Ein lokales Bild wird nicht angezeigt. Relative PNG nur im Textverzeichnis unterhalb des Limits.

Dokumentation

• OpenAI: Plugin-Paketierung

• OpenAI Plugin-Dokumentation

Das ist ein unabhängiges Projekt, kein offizielles Produkt von OpenAI aber GitHub. Produktnamen etc. gehören den jeweiligen Rechteinhabern.