Tiptap Collaboration MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with Tiptap Collaboration services.

Tools Available

Health & Statistics

get_collaboration_health

Check the health status of the Tiptap collaboration service.

• Parameters: None
• Returns: Health status information (DB, Redis, License status)

get_server_statistics

Get server-wide usage statistics.

• Parameters: None
• Returns: Total documents, connections, concurrent users, version info

get_document_statistics

Get real-time statistics for a specific document.

• Parameters:
  • id (string): Document ID
• Returns: Current connections, connected IPs, document activity

Document Management

create_document

Create a new collaborative document.

• Parameters:
  • name (string): Name of the document
  • content (string, optional): Initial content for the document
• Returns: Created document information

get_document

Retrieve information about a specific collaborative document.

• Parameters:
  • id (string): ID of the document to retrieve
• Returns: Document information and content

list_documents

List all available collaborative documents.

• Parameters: None
• Returns: Array of all documents in the system

update_document

Update a collaborative document with new content.

• Parameters:
  • id (string): Document ID
  • content (object): Document content in Tiptap JSON format
  • mode (string, optional): Update mode - "replace" or "append" (default: "replace")
• Returns: Updated document information

delete_document

Delete a collaborative document.

• Parameters:
  • id (string): ID of the document to delete
• Returns: Deletion confirmation

Advanced Document Operations

duplicate_document

Duplicate an existing collaborative document.

• Parameters:
  • sourceId (string): ID of the source document to duplicate
  • targetId (string): ID for the new duplicated document
• Returns: Duplicated document information

encrypt_document

Encrypt a collaborative document using Base64 encryption.

• Parameters:
  • id (string): Document ID
  • content (object): Document content in Tiptap JSON format to encrypt
• Returns: Encryption confirmation

search_documents

Search documents using semantic search (requires Tiptap Semantic Search).

• Parameters:
  • query (string): Search query
  • limit (number, optional): Maximum results to return (default: 10)
• Returns: Array of matching documents with relevance scores

Markdown Conversion

import_markdown

Convert Markdown content to Tiptap JSON format.

• Parameters:
  • appId (string): Your Tiptap App ID for the conversion service
  • content (string): Markdown content to convert
  • format (string, optional): "md" or "gfm" (GitHub Flavored Markdown, default: "md")
• Returns: Converted Tiptap JSON content

export_markdown

Convert Tiptap JSON content to Markdown format.

• Parameters:
  • appId (string): Your Tiptap App ID for the conversion service
  • content (object): Tiptap JSON content to convert
  • format (string, optional): "md" or "gfm" (GitHub Flavored Markdown, default: "md")
• Returns: Converted Markdown content

Batch Operations

batch_import_documents

Import multiple documents in bulk using a predefined JSON structure.

• Parameters:
  • documents (array): Array of document arrays, where each inner array represents versions of a single document
• Returns: Import results for all documents

Installation

git clone <repository-url>
cd tiptap-collaboration-mcp
npm install
npm run build

Configuration

The server requires both a BASE_URL and API_TOKEN to connect to your Tiptap collaboration service.

Required Parameters

BASE_URL (Required)

The base URL of your Tiptap collaboration service. This parameter is required and the server will exit if not provided.

API_TOKEN (Recommended)

API token for authentication with the Tiptap collaboration service. While not strictly required, most operations will fail without proper authentication.

Command Line Usage

node /path/to/build/index.js BASE_URL <url> API_TOKEN <token>

Client Usage

Add this server to your Claude, Windsurf, or any other client the relevant syntax. An example:

{
  "mcpServers": {
    "user": {
      "tiptap-collaboration": {
        "command": "node",
        "args": [
          "/path/to/tiptap-collaboration-mcp/build/index.js",
          "BASE_URL",
          "http://localhost:8080",
          "API_TOKEN",
          "your-actual-api-token"
        ]
      }
    }
  }
}

License

This project is licensed under the MIT License - see the LICENSE file for details.