plsreadme

Das Problem

Du hast eine README, ein PRD, Besprechungsnotizen oder eine API-Dokumentation in Markdown geschrieben. Jetzt musst du sie mit jemandem teilen, der keinen Markdown-Renderer hat, GitHub nicht nutzt oder einfach einen sauberen Link benötigt, den er im Browser öffnen kann.

plsreadme verwandelt jedes Markdown in einem Schritt in eine dauerhafte, schön gerenderte Webseite. Keine Konten. Keine Registrierungen. Keine Reibungsverluste.

✨ Funktionen

• Sofortiges Teilen — Markdown einfügen oder Datei hochladen, einen plsrd.me-Link erhalten

• Schönes Rendering — Saubere Typografie, Dark Mode, mobil-responsiv

• Inline-Kommentare — Leser können auf jeden Absatz klicken und Feedback hinterlassen

• Review-Modus (Aktuell vs. Zeitstrahl) — Dokumente mit mehreren Versionen zeigen standardmäßig Feedback zum aktuellen Entwurf mit Ein-Klick-Zugriff auf die vollständige Zeitstrahl-Historie

• KI-Auto-Formatierung — Wirf rohen Text hinein; er kommt als sauberes Markdown heraus

• MCP-Server — Teile Dokumente direkt aus Claude, Cursor, VS Code oder jedem MCP-Client

• OpenClaw-Skill — Verfügbar auf ClawHub für KI-Agenten-Workflows

• Kurz-Links — Jedes Dokument erhält eine kompakte plsrd.me/v/xxx-URL

• Raw-Zugriff — Lade die ursprüngliche .md-Datei von jedem geteilten Link herunter

• Versions-Zeitstrahl + sichere Wiederherstellung — /v/:id/versions + /v/:id/history + Archiv-zuerst-Wiederherstellungs-API für schnelles Rollback

• Clerk-Auth-Grundlage — GitHub/Google-Anmeldung + Clerk-gehostetes E-Mail-Fallback + Backend-Auth-Verifizierungs-Utilities

• Eigentumsmodell (Phase 2) — Dokumente können mit einem Clerk-Benutzer (owner_user_id) verknüpft werden, während anonyme Abläufe erhalten bleiben

• Meine Links-Dashboard (Phase 3) — Authentifizierte /my-links-Seite mit Suche/Sortierung/Paginierung und Aktionen zum schnellen Kopieren/Öffnen

• Beanspruchung von Legacy-Links (Phase 4) — Angemeldete Benutzer können ältere anonyme Links beanspruchen, indem sie das ursprüngliche admin_token nachweisen

• Zero-Config-Website-Demo — Kein Konto oder API-Schlüssel erforderlich, um es im Browser auszuprobieren

🚀 Schnellstart

Web

Gehe zu plsreadme.com, füge dein Markdown ein, klicke auf Teilen.

Auth-Pfade und Rollout-Status

Empfohlene Reihenfolge:

1. Zuerst im Browser ausprobieren — schnellster Demo-Pfad, keine MCP-Einrichtung erforderlich.

2. Gehostetes Remote-MCP mit Browser-Login verwenden, wenn die Client-Unterstützung verifiziert ist.

3. API-Schlüssel / lokales MCP-Fallback verwenden, wenn interaktives Login nicht verfügbar ist.

Aktueller Rollout-Status:

Hinweise zum gehosteten Remote-MCP-Rollout:

• https://plsreadme.com/mcp

• https://plsreadme.com/sse

Diese gehosteten Remote-MCP-Routen sind im Code hinter einem OAuth-geschützten Browser-Login live, einschließlich /authorize, /oauth/token und /oauth/register.

Betriebliche Hinweise:

• D1 doc_create_events ist die kanonische Tabelle für die Erstellungszuordnung über Web-, gehostete MCP- und lokale MCP-Abläufe hinweg.

• docs.raw_view_count verfolgt jeden Render-Aufruf, während docs.view_count für wahrscheinlich menschliche Aufrufe reserviert ist.

• Siehe docs/runbooks/auth-surface-monitoring.md für das Produktions-Abfrageset und die Reaktionsschritte.

• Zugriffstokens halten etwa 1 Stunde

• Refresh-Tokens halten etwa 30 Tage

• Das erneute Verbinden desselben Clients ersetzt die ältere Berechtigung

• Das Abmelden von der Website widerruft nicht von selbst eine bestehende Editor-Berechtigung

• Dieses Repo ist jetzt mit einer dedizierten Cloudflare Workers KV-Bindung namens OAUTH_KV verbunden

Wenn das Browser-Login in deinem Client nicht verfügbar ist, erstelle einen persönlichen API-Schlüssel unter /my-links und verwende entweder das gehostete Remote-Header-Fallback oder das lokale npx -y plsreadme-mcp-Paket.

Vertrauensmodell der Website-Demo heute:

• Anonyme Website-Erstellungen unter /api/create-link erfordern eine kurzlebige Browser-Verifizierungsberechtigung

• Angemeldete Website-Erstellungen überspringen diese Berechtigung und bleiben reibungsarm

• Die UI nach der Erstellung verzweigt jetzt in In meinem Konto speichern, Editor verbinden und Link kopieren

API

curl -X POST https://plsreadme.com/api/render \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Hello World\n\nThis is my doc."}'

{
  "id": "abc123def456",
  "url": "https://plsreadme.com/v/abc123def456",
  "raw_url": "https://plsreadme.com/v/abc123def456/raw",
  "admin_token": "sk_..."
}

Speichere das admin_token — du wirst es zum Bearbeiten oder Löschen benötigen:

# Update
curl -X PUT https://plsreadme.com/v/abc123def456 \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"markdown": "# Updated content"}'

# Delete
curl -X DELETE https://plsreadme.com/v/abc123def456 \
  -H "Authorization: Bearer sk_..."

Versions-Zeitstrahl + sichere Wiederherstellung

Verwende den Zeitstrahl-Endpunkt, um den Revisionskontext während KI-Iterationszyklen zu überprüfen:

curl https://plsreadme.com/v/abc123def456/versions

{
  "id": "abc123def456",
  "current_version": 5,
  "total_versions": 5,
  "versions": [
    { "version": 5, "is_current": true, "raw_url": "https://plsreadme.com/v/abc123def456/raw" },
    { "version": 4, "is_current": false, "raw_url": "https://plsreadme.com/v/abc123def456/raw?version=4" }
  ]
}

Wenn eine KI-Bearbeitung das Dokument verschlechtert, stelle einen früheren Schnappschuss wieder her (Archiv-zuerst, nicht destruktiv):

curl -X POST https://plsreadme.com/v/abc123def456/restore \
  -H "Authorization: Bearer sk_..." \
  -H "Content-Type: application/json" \
  -d '{"version": 4}'

Die Wiederherstellung ist ähnlich wie Aktualisierungen ratenbegrenzt (derzeit 60/Stunde pro Akteur-Schlüssel), um Missbrauch zu reduzieren.

Für Dokumente, die einem authentifizierten Clerk-Benutzer gehören, erfordern Aktualisieren/Löschen/Wiederherstellen auch diese Eigentümer-Sitzung (um eine Mutation durch andere Benutzer zu verhindern), während anonyme Dokumente weiterhin nur mit admin_token funktionieren.

Hinweise zur Verwendung des Review-Modus (Zuerst aktueller Entwurf, Zeitstrahl auf Anfrage)

Der Dokumenten-Viewer bietet jetzt Kontrollen für die Kommentarüberprüfung:

• Aktueller Entwurf — zeigt nur Kommentare, die mit der neuesten Dokumentversion verknüpft sind (Standard, wenn ein Dokument mehrere Versionen hat).

• Zeitstrahl — zeigt die vollständige Kommentarhistorie über alle Versionen hinweg.

Du kannst dieselben Modi direkt über die API abrufen:

# Latest-version comments only
curl "https://plsreadme.com/api/comments/abc123def456?view=current"

# Full timeline comments (default API behavior)
curl "https://plsreadme.com/api/comments/abc123def456?view=all"

Viewer-Links behalten den Modus in der URL für teilbaren Review-Kontext bei:

• https://plsreadme.com/v/abc123def456?view=current

• https://plsreadme.com/v/abc123def456?view=timeline

Um einen Legacy-Anonym-Link in dein angemeldetes Konto zu beanspruchen:

curl -X POST https://plsreadme.com/api/auth/claim-link \
  -H "Authorization: Bearer <clerk-session-jwt>" \
  -H "Content-Type: application/json" \
  -d '{"id":"abc123def456","adminToken":"sk_..."}'

MCP (KI-Editoren)

Aktuelle Empfehlung heute:

• Verwende gehostetes Remote-MCP mit Browser-Login, wenn dein Client dies sauber unterstützt

• Verwende das persönliche API-Schlüssel-Fallback, wenn Remote-Auth nicht verfügbar oder umständlich in diesem Client ist

• Verwende das lokale plsreadme-mcp-Paket mit PLSREADME_API_KEY für den sichersten stdio-Pfad

Verbinde deinen Editor mit plsreadme und teile Dokumente mit natürlicher Sprache:

"Teile diese README als plsreadme-Link" "Verwandle mein PRD in eine teilbare Seite" "Mache diese Besprechungsnotizen zu einem lesbaren Link"

MCP/Agenten-Auto-Review-Schleife mit /versions

Für iterative KI-Schreibabläufe (Entwurf → Kritik → Überarbeitung) können Agenten /v/:id/versions als Quelle der Wahrheit nutzen:

1. Behalte die kanonische lesbare URL (/v/:id) für Menschen bei.

2. Polle /v/:id/versions zwischen den Iterationen.

3. Vergleiche current_version mit der zuletzt überprüften Version.

4. Wenn geändert, rufe raw_url für die neueste Version ab und führe Review-Prüfungen durch.

5. Wenn die Qualität nachlässt, löse optional /v/:id/restore mit Admin-Token + Eigentümer-Sitzung aus.

Dies ermöglicht eine deterministische Revisionsverfolgung durch Automatisierung, ohne HTML zu scrapen.

Siehe docs/ai-iteration-versioning.md für ein vollständiges Playbook.

🔌 MCP-Einrichtung

Client-Kompatibilitätsmatrix

Stand: 5. April 2026:

Gehostetes Remote-Login (unterstützte Clients)

Claude Code:

claude mcp add --transport http plsreadme https://plsreadme.com/mcp

Cursor:

{
  "mcpServers": {
    "plsreadme": {
      "url": "https://plsreadme.com/mcp"
    }
  }
}

VS Code:

{
  "servers": {
    "plsreadme": {
      "type": "http",
      "url": "https://plsreadme.com/mcp"
    }
  }
}

Windsurf:

{
  "mcpServers": {
    "plsreadme": {
      "serverUrl": "https://plsreadme.com/mcp"
    }
  }
}

Lebenszyklus-Hinweise:

• Zugriffstoken-TTL beträgt etwa 1 Stunde

• Refresh-Token-TTL beträgt etwa 30 Tage

• Das erneute Verbinden desselben Clients ersetzt die ältere Berechtigung

• Abmelden beendet die Website-Sitzung, widerruft aber nicht automatisch eine bestehende Editor-Berechtigung

• Verwende GET /api/auth/mcp-grants und DELETE /api/auth/mcp-grants/:grantId, um gehostete Editor-Berechtigungen zu prüfen oder zu widerrufen

Wenn dein Client Browser-Login unterstützt, bevorzuge diesen Pfad. Es ist die sauberste Einrichtung und hält Dokumente im Besitz automatisch mit deinem Website-Konto verknüpft.

Gehostetes Remote-API-Schlüssel-Fallback

Erstelle zuerst einen persönlichen API-Schlüssel unter https://plsreadme.com/my-links, dann verwende einen dieser Wege:

Claude Code:

claude mcp add --transport http \
  --header "Authorization: Bearer $PLSREADME_API_KEY" \
  plsreadme-api https://plsreadme.com/mcp

Cursor:

{
  "mcpServers": {
    "plsreadme-api": {
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}

VS Code:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "plsreadme-api-key",
      "description": "plsreadme personal API key",
      "password": true
    }
  ],
  "servers": {
    "plsreadme-api": {
      "type": "http",
      "url": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${input:plsreadme-api-key}"
      }
    }
  }
}

Windsurf:

{
  "mcpServers": {
    "plsreadme-api": {
      "serverUrl": "https://plsreadme.com/mcp",
      "headers": {
        "Authorization": "Bearer ${env:PLSREADME_API_KEY}"
      }
    }
  }
}

Raw-Remote-Endpunkt-Benutzer:

curl -i https://plsreadme.com/mcp \
  -H "Authorization: Bearer $PLSREADME_API_KEY"

Lokales npm-Fallback

Claude Code:

claude mcp add --transport stdio \
  --env PLSREADME_API_KEY=$PLSREADME_API_KEY \
  plsreadme -- npx -y plsreadme-mcp

Cursor: Füge zu ~/.cursor/mcp.json hinzu:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${env:PLSREADME_API_KEY}"
      }
    }
  }
}

VS Code: Füge zu .vscode/mcp.json hinzu:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "plsreadme-api-key",
      "description": "plsreadme personal API key",
      "password": true
    }
  ],
  "servers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${input:plsreadme-api-key}"
      }
    }
  }
}

Claude Desktop: Füge zu claude_desktop_config.json hinzu:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "<paste-your-personal-api-key>"
      }
    }
  }
}

Windsurf: Füge zu ~/.codeium/windsurf/mcp_config.json hinzu:

{
  "mcpServers": {
    "plsreadme": {
      "command": "npx",
      "args": ["-y", "plsreadme-mcp"],
      "env": {
        "PLSREADME_API_KEY": "${env:PLSREADME_API_KEY}"
      }
    }
  }
}

Hinweise:

• lokales stdio erwartet jetzt standardmäßig PLSREADME_API_KEY, damit neue Dokumente im Besitz sind

• expliziter Legacy-Anonym-Modus existiert weiterhin mit PLSREADME_ALLOW_ANONYMOUS=1

• erstelle deinen Schlüssel unter https://plsreadme.com/my-links

Migration bestehender anonymer MCP-Setups

Wenn du plsreadme-mcp bereits anonym genutzt hast:

1. Erstelle einen persönlichen API-Schlüssel unter /my-links.

2. Füge PLSREADME_API_KEY zu deiner MCP-Client-Konfiguration hinzu.

3. Behalte PLSREADME_ALLOW_ANONYMOUS=1 nur als temporäre Kompatibilitätskrücke für alte Workflows bei.

4. Beanspruche ältere anonyme Links später mit /api/auth/claim-link, falls du noch deren admin_token hast.

Die Migrationsregel ist einfach:

• neue