Tiptap Collaboration

You can use this MCP server to interact with Tiptap Collaboration services through a set of tools that manage health, statistics, documents, conversions, and batch operations. This guide walks you through using the server in practical scenarios, installing it, and configuring it for secure connections.

How to use

You connect to the MCP server from your MCP client and call tools to perform operations such as checking health, managing documents, converting content, and running bulk imports. The server exposes a consistent set of endpoints that you can invoke to create, retrieve, update, and delete documents, as well as to search, encrypt, or duplicate content. Make sure you supply the required authentication and base URL as part of your client configuration.

How to install

# Prerequisites
# Ensure you have Node.js installed (>= 14.x or newer)
node -v
npm -v

# Clone the MCP server repository
git clone <repository-url>
cd tiptap-collaboration-mcp

# Install dependencies
npm install

# Build the project
npm run build

# Start the server (example depends on build output)
node /path/to/tiptap-collaboration-mcp/build/index.js BASE_URL <url> API_TOKEN <token>

Configuration and security

The MCP server requires two environment values to operate with the Tiptap collaboration service: BASE_URL and API_TOKEN. BASE_URL is the base address of your Tiptap collaboration service and is required. API_TOKEN is used to authenticate with the service and is recommended for reliable access. When you run the server, supply these values in the startup command or via your hosting/controller configuration.

Typical startup includes passing BASE_URL and API_TOKEN as arguments, which are then read by the MCP server to establish a connection to the Tiptap service.

Troubleshooting and notes

If you encounter authentication failures, verify that your API_TOKEN is correct and that your BASE_URL points to a valid Tiptap service endpoint. Check that the environment you run in allows outbound connections to the BASE_URL and that any firewalls or proxies permit the required traffic. For health-related issues, use the health check tool to confirm that the database, Redis, and licensing components are reachable.

Host configuration example

You can run the MCP server via a host that invokes the Node runtime with the built index. The following example shows how to wire the server into a host configuration.

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

Available tools

get-collaboration-health

Check the health status of the Tiptap collaboration service, including DB, Redis, and license status.

get-server-statistics

Fetch server-wide usage statistics such as total documents, connections, concurrent users, and version info.

get-document-statistics

Retrieve real-time statistics for a specific document by its ID, including connections and activity.

create-document

Create a new collaborative document with a name and optional initial content in Tiptap JSON format.

get-document

Retrieve information and content for a specific collaborative document by ID.

list-documents

List all available collaborative documents.

update-document

Update a document with new content using replace or append mode.

delete-document

Delete a collaborative document by ID.

duplicate-document

Duplicate an existing document with a new target ID.

encrypt-document

Encrypt a document content using Base64 encryption.

search-documents

Search documents semantically (requires Tiptap Semantic Search) and return relevant results.

import-markdown

Convert Markdown content to Tiptap JSON format using your Tiptap App ID.

export-markdown

Convert Tiptap JSON content to Markdown format using your Tiptap App ID.

batch-import-documents

Import multiple documents in bulk from a predefined JSON structure.