Tiptap 协作 MCP 服务器

这是一个提供与 Tiptap 协作服务交互工具的 Model Context Protocol (MCP) 服务器。

可用工具

健康状态及统计信息

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 (字符串，可选)：更新模式 - "替换" 或 "追加"（默认："替换"）
• 返回值：更新后的文档信息

delete-document

删除协作文档。

• 参数：
  • id (字符串)：要删除的文档ID
• 返回值：删除确认信息

高级文档操作

duplicate-document

复制现有的协作文档。

• 参数：
  • sourceId (字符串)：要复制的源文档ID
  • targetId (字符串)：新复制文档的ID
• 返回值：复制的文档信息

encrypt-document

使用 Base64 加密对协作文档进行加密。

• 参数：
  • id (字符串)：文档ID
  • content (对象)：要加密的文档内容，以 Tiptap JSON 格式表示
• 返回值：加密确认信息

search-documents

使用语义搜索搜索文档（需要 Tiptap 语义搜索）。

• 参数：
  • query (字符串)：搜索查询
  • limit (数字，可选)：返回的最大结果数（默认：110）
• 返回值：匹配文档的数组及其相关性评分

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 (数组)：文档数组的数组，其中每个内部数组代表单个文档的不同版本
• 返回值：所有文档的导入结果

安装

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

资源

• ModelContextProtocol
• ModelContextProtocol SDK
• Tiptap 协作 API

许可证

本项目根据 MIT 许可证发布 - 查看 LICENSE 文件了解详细信息。