Zum Inhalt springen
satware® AI OnlyOffice MCP

Installation

Voraussetzungen

Abschnitt betitelt „Voraussetzungen“
Anforderung Version Zweck
Node.js >= 24.0.0 Laufzeitumgebung für den MCP-Server
npm >= 11 Paketmanager
Docker 24.0+ OnlyOffice Document Server-Container
Docker Compose v2 Multi-Service-Orchestrierung

Installationsschritte

Abschnitt betitelt „Installationsschritte“

  1. Repository klonen

    Terminal window
    git clone https://gitlab.satware.com/satware/mcp/onlyoffice.git
    cd onlyoffice

  2. Abhängigkeiten installieren

    Terminal window
    npm ci

  3. OnlyOffice Document Server starten

    Der MCP-Server benötigt einen laufenden OnlyOffice Document Builder-Container zur Dokumentgenerierung.

    Terminal window
    docker compose -f docker/docker-compose.yml up -d

    Überprüfen Sie, ob der Document Server fehlerfrei läuft:

    Terminal window
    curl -f http://localhost:9980/healthcheck
    # Erwartet: true

  4. MCP-Server builden

    Terminal window
    npm run build

    Dies kompiliert TypeScript nach dist/ und erstellt die Admin-Oberfläche unter dist/admin-ui/index.html.

  5. Tests ausführen (optional)

    Terminal window
    npm test          # Unit-Tests
    npm run test:int  # Integrationstests (erfordert Docker)

Umgebungsvariablen

Abschnitt betitelt „Umgebungsvariablen“

Erforderlich

Abschnitt betitelt „Erforderlich“
Variable Beschreibung Standardwert
ONLYOFFICE_JWT_SECRET JWT-Geheimnis für die Kommunikation mit dem OnlyOffice Document Server -

Optional (häufig)

Abschnitt betitelt „Optional (häufig)“
Variable Beschreibung Standardwert
MCP_PORT HTTP-Server-Port 3847
ADMIN_PASSWORD Passwort für die /admin-Oberfläche. Falls nicht gesetzt, gibt /admin 503 zurück -
CREDENTIAL_MASTER_PASSWORD Aktiviert die Verwaltungstools für Anmeldeinformationen (5 zusätzliche MCP-Tools) -
ARTIFACTS_BASE_URL Basis-URL für Artefakt-Downloads (STDIO-Modus). Falls nicht gesetzt, werden Artefakte als Base64 zurückgegeben -
CORS_ORIGINS Durch Komma getrennte erlaubte Origins für den /mcp-Endpunkt * (Entwicklung)

Siehe den Bereitstellungsleitfaden für die vollständige Umgebungsvariablen-Referenz.

Installation überprüfen

Abschnitt betitelt „Installation überprüfen“
Terminal window
# HTTP-Server starten
npm run start:server


# Health-Check durchführen
curl -f http://localhost:3847/health
# Erwartet: {"status":"healthy","version":"1.3.0",...}

Nächste Schritte

Abschnitt betitelt „Nächste Schritte“