Tiptap Collaboration MCP

🚀 Tiptap協作MCP服務器

Tiptap協作MCP服務器是一個模型上下文協議（MCP）服務器，它提供了與Tiptap協作服務進行交互的工具。

🚀 快速開始

安裝

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

配置

該服務器需要 BASE_URL 和 API_TOKEN 才能連接到你的Tiptap協作服務。

必需參數

• BASE_URL（必需）：你的Tiptap協作服務的基礎URL。此參數是必需的，如果未提供，服務器將退出。
• API_TOKEN（建議）：用於與Tiptap協作服務進行身份驗證的API令牌。雖然不是嚴格必需的，但如果沒有適當的身份驗證，大多數操作將會失敗。

命令行使用

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

主機使用

將此服務器添加到你的Claude、Windsurf或任何其他具有相關語法的主機中。示例如下：

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

✨ 主要特性

可用工具

健康與統計

• get-collaboration-health：檢查Tiptap協作服務的健康狀態。
  • 參數：無
  • 返回值：健康狀態信息（數據庫、Redis、許可證狀態）
• get-server-statistics：獲取服務器的使用統計信息。
  • 參數：無
  • 返回值：文檔總數、連接數、併發用戶數、版本信息
• get-document-statistics：獲取特定文檔的即時統計信息。
  • 參數：
    • id（字符串）：文檔ID
  • 返回值：當前連接數、連接的IP地址、文檔活動情況

文檔管理

• create-document：創建一個新的協作文檔。
  • 參數：
    • name（字符串）：文檔名稱
    • content（對象，可選）：以Tiptap JSON格式表示的文檔初始內容
  • 返回值：創建的文檔信息
• get-document：檢索特定協作文檔的信息。
  • 參數：
    • id（字符串）：要檢索的文檔ID
  • 返回值：文檔信息和內容
• list-documents：列出所有可用的協作文檔。
  • 參數：無
  • 返回值：系統中所有文檔的數組
• update-document：用新內容更新協作文檔。
  • 參數：
    • id（字符串）：文檔ID
    • content（對象）：以Tiptap JSON格式表示的文檔內容
    • mode（字符串，可選）：更新模式 - "replace" 或 "append"（默認："replace"）
  • 返回值：更新後的文檔信息
• delete-document：刪除一個協作文檔。
  • 參數：
    • id（字符串）：要刪除的文檔ID
  • 返回值：刪除確認信息

高級文檔操作

• duplicate-document：複製一個現有的協作文檔。
  • 參數：
    • sourceId（字符串）：要複製的源文檔ID
    • targetId（字符串）：新複製文檔的ID
  • 返回值：複製的文檔信息
• encrypt-document：使用Base64加密對協作文檔進行加密。
  • 參數：
    • id（字符串）：文檔ID
    • content（對象）：要加密的以Tiptap JSON格式表示的文檔內容
  • 返回值：加密確認信息
• search-documents：使用語義搜索來搜索文檔（需要Tiptap語義搜索）。
  • 參數：
    • query（字符串）：搜索查詢
    • limit（數字，可選）：返回的最大結果數（默認：10）
  • 返回值：帶有相關性分數的匹配文檔數組

Markdown轉換

• import-markdown：將Markdown內容轉換為Tiptap JSON格式。
  • 參數：
    • appId（字符串）：用於轉換服務的Tiptap應用ID
    • content（字符串）：要轉換的Markdown內容
    • format（字符串，可選）："md" 或 "gfm"（GitHub風格Markdown，默認："md"）
  • 返回值：轉換後的Tiptap JSON內容
• export-markdown：將Tiptap JSON內容轉換為Markdown格式。
  • 參數：
    • appId（字符串）：用於轉換服務的Tiptap應用ID
    • content（對象）：要轉換的Tiptap JSON內容
    • format（字符串，可選）："md" 或 "gfm"（GitHub風格Markdown，默認："md"）
  • 返回值：轉換後的Markdown內容

批量操作

• batch-import-documents：使用預定義的JSON結構批量導入多個文檔。
  • 參數：
    • documents（數組）：文檔數組，其中每個內部數組表示單個文檔的版本
  • 返回值：所有文檔的導入結果

📚 詳細文檔

資源

• ModelContextProtocol
• ModelContextProtocol SDK
• Tiptap協作API

📄 許可證

本項目採用MIT許可證 - 有關詳細信息，請參閱 LICENSE 文件。