Skip to content
satware® AI OnlyOffice MCP

Quick Start

Prerequisites

Section titled “Prerequisites”

Complete the Installation guide first. You need:

  • A running OnlyOffice Document Server container
  • A built MCP server (npm run build)
  • An MCP client (or curl for testing)

Generate a Document

Section titled “Generate a Document”

  1. Start the MCP server

    For HTTP mode (easier to test with curl):

    Terminal window
    npm run start:server

    Verify it’s running:

    Terminal window
    curl -f http://localhost:3847/health

  2. List available templates

    Terminal window
    curl -X POST http://localhost:3847/mcp \
      -H "Content-Type: application/json" \
      -H "Accept: application/json, text/event-stream" \
      -d '{
        "jsonrpc": "2.0",
        "id": 1,
        "method": "tools/call",
        "params": {
          "name": "onlyoffice_list_templates",
          "arguments": {}
        }
      }'

    This returns 5 generic templates.

  3. Generate a job description

    Terminal window
    curl -X POST http://localhost:3847/mcp \
      -H "Content-Type: application/json" \
      -H "Accept: application/json, text/event-stream" \
      -d '{
        "jsonrpc": "2.0",
        "id": 2,
        "method": "tools/call",
        "params": {
          "name": "onlyoffice_generate_document",
          "arguments": {
            "template": "stellenbeschreibung",
            "format": "docx",
            "data": {
              "Positionstitel": "Software Engineer",
              "Fachbereich": "IT",
              "Abteilung": "Development",
              "Standort": "Berlin",
              "Datum": "06.07.2026",
              "Arbeitsverhaeltnis": "Vollzeit",
              "Stellenziel": "Develop and maintain software applications",
              "Hauptaufgaben": ["Code development", "Code review", "Testing"],
              "Nebenaufgaben": ["Documentation", "Team meetings"]
            }
          }
        }
      }'

    The response contains the generated document as base64 data or a download URL (depending on ARTIFACTS_BASE_URL configuration).

  4. Connect your MCP client

    For local clients (Claude Desktop, Cline), use STDIO mode:

    {
      "mcpServers": {
        "onlyoffice": {
          "command": "node",
          "args": ["dist/index.js"],
          "cwd": "/path/to/onlyoffice"
        }
      }
    }

    For remote clients (opencode, TypingMind), use HTTP mode:

    {
      "mcp": {
        "onlyoffice": {
          "type": "remote",
          "url": "https://onlyoffice.localhost/mcp"
        }
      }
    }

Available Templates

Section titled “Available Templates”
Template Format Description
stellenbeschreibung DOCX/PDF Job description (HR)
dienstliches_schreiben DOCX/PDF Official letter
beschlussvorlage DOCX/PDF Council decision proposal
praesentation PPTX/PDF Professional presentation
bericht XLSX/PDF Tabular report with formulas
See the Templates Reference for full schema details.

Next Steps

Section titled “Next Steps”