Tools-Referenz

Alle 26 Tools sind sowohl über STDIO- als auch über HTTP-Transporte verfügbar. Jedes Tool gibt eine JSON-Antwort mit einem success-Booleschen Wert und entweder den Ergebnisdaten oder einer Fehlermeldung zurück.

Builder

Tool	Zweck
onlyoffice_generate_document	Ein Dokument aus einer Vorlage generieren
onlyoffice_batch_generate	Mehrere Dokumente parallel generieren
onlyoffice_list_templates	Verfügbare Vorlagen mit Metadaten auflisten
onlyoffice_validate_data	Daten gegen ein Vorlagenschema validieren
onlyoffice_modify_document	Ein Dokument durch Datenregeneration ändern
onlyoffice_get_template_schema	Das JSON-Schema für eine Vorlage abrufen
onlyoffice_get_metadata	Metadaten aus einem Dokument extrahieren
onlyoffice_set_metadata	Metadaten in einem Dokument ändern
onlyoffice_merge_documents	Mehrere PDF-Dokumente zu einem zusammenführen
onlyoffice_split_document	Ein PDF in mehrere Teile aufteilen

Siehe auch: Vorlagen-Referenz, Metadaten-Tools

Content

Tool	Zweck
onlyoffice_extract_content	Text, Tabellen und Bilder extrahieren (alles auf einmal)
onlyoffice_extract_text	Nur Textinhalt extrahieren
onlyoffice_extract_tables	Strukturierte Tabellendaten extrahieren
onlyoffice_extract_images	Eingebettete Bilder extrahieren

Watermark

Tool	Zweck
onlyoffice_add_watermark	Text- oder Bildwasserzeichen zu PDF/DOCX hinzufügen

Storage

Tool	Zweck
onlyoffice_storage_read	Eine Datei von einem Speicheranbieter lesen
onlyoffice_storage_write	Eine Datei zu einem Speicheranbieter schreiben
onlyoffice_storage_list	Dateien in einem Verzeichnis auflisten
onlyoffice_storage_delete	Eine Datei löschen
onlyoffice_storage_exists	Prüfen, ob eine Datei existiert

Instances

Tool	Zweck
onlyoffice_list_instances	OnlyOffice-Instanzen mit optionaler Statusprüfung auflisten

Credentials

Tool	Zweck
onlyoffice_credential_store	Neue verschlüsselte Anmeldeinformationen speichern
onlyoffice_credential_get	Anmeldeinformationen nach ID abrufen
onlyoffice_credential_update	Bestehende Anmeldeinformationen aktualisieren
onlyoffice_credential_delete	Gespeicherte Anmeldeinformationen löschen
onlyoffice_credential_list	Gespeicherte Anmeldeinformations-Metadaten auflisten

Hinweis

Die Anmeldeinformations-Tools erfordern CREDENTIAL_MASTER_PASSWORD. Siehe Anmeldeinformationsverwaltung.

---

onlyoffice_generate_document

Ein Dokument (DOCX, PPTX, XLSX, PDF) aus einer Vorlage mit bereitgestellten Daten generieren.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
template	string	Ja	Vorlagenbezeichner (z.B. "stellenbeschreibung")
format	enum	Ja	"docx", "pdf", "pptx", "xlsx"
data	object	Ja	Vorlagenspezifisches Datenobjekt
outputFilename	string	Nein	Benutzerdefinierter Dateiname (Standard: automatisch generiert)
version	string	Nein	Vorlagenversion (Standard: neueste)
deliveryMethod	enum	Nein	"url" oder "base64" (Standard abhängig vom Transport)
instanceId	string	Nein	OnlyOffice-Instanz-ID (Multi-Mandant)

Beispiel

{
  "template": "stellenbeschreibung",
  "format": "docx",
  "data": {
    "Positionstitel": "Software Engineer",
    "Fachbereich": "IT",
    "Abteilung": "Development",
    "Standort": "generic",
    "Datum": "06.01.2026",
    "Arbeitsverhaeltnis": "Vollzeit",
    "Stellenziel": "Develop and maintain software applications",
    "Hauptaufgaben": ["Code development", "Code review"],
    "Nebenaufgaben": ["Documentation"]
  }
}

Antwort

{
  "success": true,
  "template": "stellenbeschreibung",
  "format": "docx",
  "artifact": {
    "data": "UEsDBBQAAAAIAA...",
    "size": 45678,
    "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "filename": "stellenbeschreibung.docx",
    "truncated": false
  }
}

Dateien über 10 MB werden nicht base64-kodiert. Prüfen Sie das Feld truncated.

Unterstützte Formate

Vorlage	DOCX	PDF	PPTX	XLSX
stellenbeschreibung	Ja	Ja
dienstliches_schreiben	Ja	Ja
beschlussvorlage	Ja	Ja
praesentation		Ja	Ja
bericht		Ja		Ja

---

onlyoffice_list_templates

Verfügbare Vorlagen mit Metadaten, Kategorien und Tags auflisten.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
category	string	Nein	Nach Kategorie filtern (z.B. "hr")
tags	string[]	Nein	Nach Tags filtern (z.B. ["german", "formal"])

Beispiel

{ "category": "hr" }

Antwort

{
  "templates": [
    {
      "id": "stellenbeschreibung",
      "name": "Stellenbeschreibung",
      "category": "hr",
      "defaultVersion": "1.0",
      "tags": ["hr", "job-description", "german", "formal"]
    }
  ],
  "count": 1
}

Kategorien

Kategorie	Beschreibung
hr	HR-Dokumente (Personalwesen)
correspondence	Briefe und offizielle Korrespondenz
government	Kommunal- und Behördendokumente
presentations	PPTX-Präsentationsvorlagen
spreadsheets	XLSX-Berichtsvorlagen

---

onlyoffice_validate_data

Daten vor der Generierung gegen ein Vorlagenschema validieren.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
template	string	Ja	Vorlagenbezeichner
data	object	Ja	Zu validierende Daten
version	string	Nein	Vorlagenversion
includeSchema	boolean	Nein	Vollständiges JSON-Schema in Antwort einbeziehen

Beispiel

{
  "template": "stellenbeschreibung",
  "data": { "Positionstitel": "Software Engineer" },
  "includeSchema": true
}

Antwort (gültig)

{
  "valid": true,
  "errors": [],
  "template": "stellenbeschreibung",
  "version": "1.0",
  "required": ["Positionstitel", "Fachbereich", "..."],
  "optional": ["Anforderungsprofil", "..."]
}

Antwort (ungültig)

{
  "valid": false,
  "errors": [
    { "field": "Fachbereich", "message": "Required field is missing", "code": "REQUIRED" },
    { "field": "Abteilung", "message": "Required field is missing", "code": "REQUIRED" }
  ]
}

Best Practice

Rufen Sie immer validate_data vor generate_document auf, um fehlende Pflichtfelder frühzeitig zu erkennen. Dadurch wird vermieden, dass eine DocBuilder-Ausführung für ungültige Daten verschwendet wird.

---

onlyoffice_get_template_schema

Das vollständige JSON-Schema für eine Vorlage abrufen (Typen, Formate, Enums, Pflicht vs. Optional).

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
id	string	Ja	Vorlagenbezeichner
version	string	Nein	Vorlagenversion (Standard: neueste)

Antwort

{
  "id": "stellenbeschreibung",
  "name": "Stellenbeschreibung",
  "version": "1.0",
  "defaultVersion": "1.0",
  "outputFormat": "docx",
  "supportedFormats": ["docx", "pdf"],
  "schema": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": { "...": "..." },
    "required": ["Positionstitel", "Fachbereich", "..."]
  }
}

---

onlyoffice_batch_generate

Mehrere Dokumente parallel generieren.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
requests	array	Ja	Array von Generierungsanfragen (1-50)
concurrency	number	Nein	Maximal parallele Generierungen (1-10, Standard: 3)
stopOnError	boolean	Nein	Beim ersten Fehler stoppen (Standard: false)

Jede Anfrage unterstützt: template, format, data, outputFilename, version.

Antwort

Gibt ein Array von Ergebnissen zurück (dasselbe Format wie generate_document für jedes).

---

onlyoffice_modify_document

Ein bestehendes Dokument ändern, indem neue Daten in das Original eingebunden und neu generiert werden.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
template	string	Ja	Vorlagenbezeichner
originalData	object	Ja	Ursprüngliche Daten zur Dokumenterstellung
modifications	object	Ja	Anzuwendende Änderungen (deep-merged)
format	enum	Ja	Ausgabeformat: "docx", "pdf", "pptx", "xlsx"
outputFilename	string	Nein	Benutzerdefinierter Dateiname
version	string	Nein	Vorlagenversion (Standard: neueste)
deliveryMethod	enum	Nein	"url" oder "base64" (transportabhängig)
instanceId	string	Nein	OnlyOffice-Instanz-ID (Multi-Mandant)

---

onlyoffice_add_watermark

Ein Text- oder Bildwasserzeichen zu einem PDF- oder DOCX-Dokument hinzufügen.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
content	string	Ja	Base64-kodiertes Dokument
format	enum	Ja	"pdf" oder "docx"
text	string	Nein	Wasserzeichentext
imageData	string	Nein	Base64-Bild (nur PDF)
position	enum	Nein	"diagonal", "center", "top-left" usw.
opacity	number	Nein	0.0 bis 1.0 (Standard: 0.3)

---

Inhaltsextraktions-Tools

onlyoffice_extract_content

Text, Tabellen und Bilder aus einem PDF- oder DOCX-Dokument in einem Aufruf extrahieren.

Eingabe

Parameter	Typ	Erforderlich	Beschreibung
content	string	Ja	Base64-kodierter Dokumentinhalt
format	enum	Ja	"pdf" oder "docx"
extractionType	enum	Nein	"text", "tables", "images" oder "all" (Standard: "all")

Antwort

{
  "success": true,
  "text": "Full text content...",
  "tables": [{ "headers": ["..."], "rows": [["..."]] }],
  "images": [{ "data": "base64...", "mimeType": "image/png" }],
  "metadata": { "pageCount": 5, "wordCount": 1234 }
}

onlyoffice_extract_text, onlyoffice_extract_tables und onlyoffice_extract_images sind einzelzweck-Varianten, die dieselben content- + format-Parameter akzeptieren, aber nur den angeforderten Typ zurückgeben.

---

PDF-Operationen

onlyoffice_merge_documents

Mehrere PDF-Dokumente zu einem zusammenführen. Akzeptiert ein Array von PDF-Quellen (base64, Pfad oder URL).

onlyoffice_split_document

Ein PDF nach Seitenbereichen oder in gleich große Teile aufteilen.

---

Fehlercodes

Code	Beschreibung
TEMPLATE_ERROR	Vorlage nicht gefunden, Version nicht verfügbar oder Registrierungsfehler
VALIDATION_ERROR	Daten haben die Schemavalidierung nicht bestanden
EXECUTION_FAILED	DocBuilder-Skriptausführung fehlgeschlagen
CONTAINER_NOT_RUNNING	Docker-Container läuft nicht oder ist nicht erreichbar
TIMEOUT	Ausführung hat das Zeitlimit überschritten

Fehlerbehandlung

Prüfen Sie das isError-Flag in MCP-Tool-Antworten. Bei einem Fehler parsen Sie das JSON aus content[0].text nach dem Feld error und dem Array validationErrors.

Verwandte Themen

• Vorlagen-Referenz - Vorlagen-Feldschemata und Beispiele
• Anmeldeinformationsverwaltung - Verschlüsselter Anmeldeinformationsspeicher
• Metadaten-Tools - PDF/DOCX-Metadaten-Extraktion und -Änderung