rustpad-mcp

Ein Model Context Protocol-Server für Rustpad, den effizienten, minimalen, selbst gehosteten kollaborativen Texteditor.

Er gibt einem KI-Assistenten Lese- und Schreibzugriff auf die Pads einer Rustpad-Instanz. Reads gehen über Rustpads HTTP-API; Writes sprechen das WebSocket-Protokoll zur Operational-Transformation, sodass gezielte Änderungen (append_to_document, replace_in_document) sauber mit dem zusammentreffen, was menschliche Kollaborateuren gleichzeitig tippen, anstatt es zu überschreiben. Während der Server ein Pad editert, ist es für alle im Pad als Bearbeiter namens rustpad-mcp sichtbar.

📖 Vollständige Dökumentation auf rustpad-mcp.ni-c.de

Anforderungen

• Ene errechbare Rustpad-Instanz (selbst gehosted; der Server iszt zustandslos und benötigt keine Anmeldedaten —Rustpad hat keine Authentifizerung)

• Nde.js >= 22, oder Docker

Related MCP server: SSH MCP Server

Konfiguration

Dieselbe URL beient die HTTP-API, den WebSocket-Endpunkt und die von den Werkzeugen zurückgegebenen Teilen-Links (<RUSTPAD_URL>/#<pad-id>). Boolesche Werte müssen exakt true sein. Der Server startet und listet seine Werkzeuge ohne Konfiguration; jeder Aufruf schlägt dann mit Einrichtungshinweisen fehl.

Beachten Sie, was Rustpad ist: Pads sind flüchig (gehen bei Serverneustart und nach 24 Stunden Inaktivität verloren, sofern die Instanz nicht mit SQLITE_URI betrieben wird) und jeder, der eine Pad-ID kennt, kann sie lesen und schreiben. Legen Sie keine Geheimnisse in Pads.

Installation

Claude Code

claude mcp add rustpad --env RUSTPAD_URL=https://rustpad.example.net -- npx rustpad-mcp

Claude Desktop

{
  "mcpServers": {
    "rustpad": {
      "command": "npx",
      "args": ["rustpad-mcp"],
      "env": {
        "RUSTPAD_URL": "https://rustpad.example.net"
      }
    }
  }
}

Codex

~/.codex/config.toml:

[mcp_servers.rustpad]
command = "npx"
args = ["-y", "rustpad-mcp"]

[mcp_servers.rustpad.env]
RUSTPAD_URL = "https://rustpad.example.net"

Docker

docker run -i --rm -e RUSTPAD_URL=https://rustpad.example.net ghcr.io/ni-c/rustpad-mcp

Werkzeuge

Mit RUSTPAD_READ_ONLY=true sind nur die ersten drei registriert.

Sicherheit

• Pad-Inhalt ist weltweit schreibbar und daher unvertraut: jedem Lesergebniss wird ein Marker vorangestellt, der dem Modell sagt, es als Daten zu behandeln, niemals als Anweissungen.

• Das Ersetzen eines nicht leeren Pads ist unwiderruflich und durch ein einmalig verwendbares Bestätigungstoken geschützt, das nur in einem vorherigen Werkzeugergebnis erscheint.

• Werkzeugergebnisse sind größenbegrenzt; Fehlertexte von Upstream werden bereinigt, bevor sie das Modell erreichen.

• RUSTPAD_INSECURE_TLS lockert die Zertifikatsprüfung nur für die konfigurierte Verbindung, niemals prozessweit.

Entwicklung

npm install
npm run lint && npm run build && npm test

Die Testsuite kommunziert über das echte MCP-Protokoll mit einem im Speicher befindlichen Fake des rustpad-Servers (einschließlich OT-Transformation gleichzeitiger Änderungen); es wird keine Live-Instanz benötigt. Das Architekturdiagramm und die Social Card werden generiert – editeren Sie docs/assets/architecture.source.svg und führen Sie npm run assets aus, niemals die gerenderten Kopien.

Veröffentlichen

Veröffentlichungen werden über Tags gesteuert. Aktualisieren Sie package.json, verschieben Sie die [Unreleased]-Notizen in der CHANGELOG.md unter die neue Version, committen Sie, dann:

git tag -s vX.Y.Z -m "vX.Y.Z"
git push origin main vX.Y.Z

Der Release-Workflow veröffentlicht auf npm via Trusted Publishing (OIDC, mit Provenance), pusht das Multi-Arch-Container-Image auf GHCR, erstellt den GitHub-Release aus dem CHANGELOG-Abschnitt und aktualisiert den Eintrag im offiziellen MCP-Registrier.

Lizenz

MIT © Willi Thiel