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 文件。