Tiptap Collaboration MCP

🚀 Tiptap Collaboration MCP Server

このサーバーは、Model Context Protocol (MCP) を使用して、Tiptap Collaborationサービスとのインタラクションを可能にするツールを提供します。

🚀 クイックスタート

このサーバーを使用することで、Tiptap Collaborationサービスとのやり取りを容易に行うことができます。以下に、利用可能なツールや操作方法を紹介します。

✨ 主な機能

ヘルスチェックと統計情報

get-collaboration-health

Tiptapコラボレーションサービスのヘルスステータスを確認します。

• パラメータ: なし
• 戻り値: ヘルスステータス情報 (DB、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 Semantic Searchが必要)。

• パラメータ:
  • query (文字列): 検索クエリ
  • limit (数値、オプション): 返す最大結果数 (デフォルト: 10)
• 戻り値: 関連性スコア付きの一致するドキュメントの配列

Markdown変換

import-markdown

MarkdownコンテンツをTiptap JSON形式に変換します。

• パラメータ:
  • appId (文字列): 変換サービスのTiptap App ID
  • content (文字列): 変換するMarkdownコンテンツ
  • format (文字列、オプション): "md" または "gfm" (GitHub Flavored Markdown、デフォルト: "md")
• 戻り値: 変換されたTiptap JSONコンテンツ

export-markdown

Tiptap JSONコンテンツをMarkdown形式に変換します。

• パラメータ:
  • appId (文字列): 変換サービスのTiptap App ID
  • content (オブジェクト): 変換するTiptap JSONコンテンツ
  • format (文字列、オプション): "md" または "gfm" (GitHub Flavored Markdown、デフォルト: "md")
• 戻り値: 変換されたMarkdownコンテンツ

バッチ操作

batch-import-documents

事前定義されたJSON構造を使用して、複数のドキュメントを一括でインポートします。

• パラメータ:
  • documents (配列): ドキュメント配列の配列。各内部配列は、単一のドキュメントのバージョンを表します。
• 戻り値: すべてのドキュメントのインポート結果

📦 インストール

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

📚 ドキュメント

設定

サーバーは、Tiptapコラボレーションサービスに接続するために、BASE_URL と API_TOKEN の両方が必要です。

必須パラメータ

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"
  ]
}

🔗 リソース

• ModelContextProtocol
• ModelContextProtocol SDK
• Tiptap Collaboration API

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細については、LICENSE ファイルを参照してください。