Skip to content

API Overview

The satware® AI OnlyOffice MCP server exposes 26 tools via the Model Context Protocol. All tools are available on both STDIO and HTTP transports.

Category Tools Description
Builder 10 Document generation, batch, merge, split, templates, validation, metadata
Content 4 Extract text, tables, and images from documents
Watermark 1 Add text or image watermarks to PDF/DOCX
Storage 5 Read, write, list, delete, and check files across 7 providers
Instances 1 List configured OnlyOffice instances with health status
Credentials 5 Store, retrieve, update, delete, and list encrypted credentials
Template Category Format Description
stellenbeschreibung HR DOCX/PDF Job description
dienstliches_schreiben Correspondence DOCX/PDF Official letter
beschlussvorlage Government DOCX/PDF Council decision proposal
praesentation Presentations PPTX/PDF Professional presentation
bericht Spreadsheets XLSX/PDF Tabular report with formulas

See the Templates Reference for full field schemas and examples.

Tools Reference

Credential Management

Templates Reference

Metadata Tools

Both transports expose the same 26 tools. Pick the one matching your MCP client:

Mode Use Case Setup Guide
STDIO Local clients (Claude Desktop, Cline, Hermes) STDIO Setup
HTTP Remote clients (opencode, TypingMind, OpenClaw) HTTP Setup
  • MCP Protocol Version: 2025-11-25
  • Transport: Streamable HTTP (HTTP mode), stdio (STDIO mode)
  • Tool Annotations: All tools carry readOnlyHint / idempotentHint annotations per MCP spec
  • Logging: Server emits logging/message notifications for tool start/duration/error
  • Resources: 3 MCP resources (template schemas, generated documents, instance health)
  • Prompts: 3 prompt templates (beschlussvorlage, stellenausschreibung, dienstliches_schreiben)