文档管理协议服务器

Docmost MCP服务器是一个模型上下文协议服务器,使AI代理能够搜索、创建、修改和组织文档页面和空间。

  • by MrMartiniMo
  • TypeScript
  • 本地部署
  • 32 星标
  • 更新于
在 GitHub 查看 MrMartiniMo/docmost-mcp

使用说明

Docmost MCP服务器

一种模型上下文协议(MCP)服务器 文档大师,使AI代理能够搜索、创建、修改和组织文档页面和空间。

特性

核心管理层

  • create_page:智能创建工具。一次性创建内容(通过导入)并处理层次结构(嵌套在父级下)。
  • update_page:更新页面的内容和/或标题。更新是通过实时协作(WebSocket)执行的。
  • delete_page / delete_pages:一次删除单个或多个页面。
  • move_page:通过将页面移动到新的父级或根级来分层组织页面。

勘探与检索

  • search:使用可选的空格过滤在空格间进行全文搜索(query, spaceId).
  • get_workspace:获取有关当前Docmost工作区的信息。
  • list_spaces:查看当前工作空间内的所有空间。
  • list_groups:查看当前工作区中的所有组。
  • list_pages:列出空间内的页面(按顺序排列 updatedAt 下降)。
  • get_page:检索特定页面的完整内容和元数据。

技术细节

  • 自动Markdown转换:页面内容会自动从Docmost的内部ProseMirror/TipTap JSON格式转换为干净的Markdown,以便于代理使用。支持所有Docmost扩展,包括标注、任务列表、数学块、嵌入等。
  • 智能导入API:在创建页面时,使用Docmost的导入API确保干净的Markdown到ProseMirror转换。
  • 儿童保护:The update_page 该工具创建了一个新的页面ID,但通过将现有的子页面重新绑定到新版本,有效地模拟了就地更新。
  • 分页支持:自动处理大型数据集(空间、页面、组)的分页。
  • 筛选后的响应:API响应经过过滤,仅包含相关信息,从而优化代理的数据传输。

安装

npm install
npm run build

配置

此服务器需要设置以下环境变量:

  • DOCMOST_API_URL:Docmost API的完整URL(例如。, https://docs.example.com/api).
  • DOCMOST_EMAIL:用于身份验证的电子邮件地址。
  • DOCMOST_PASSWORD:用于身份验证的密码。

使用克劳德桌面/通用MCP客户端

将以下内容添加到MCP配置中(例如。 claude_desktop_config.json):

{
  "mcpServers": {
    "docmost-local": {
      "command": "node",
      "args": ["./build/index.js"],
      "env": {
        "DOCMOST_API_URL": "http://localhost:3000/api",
        "DOCMOST_EMAIL": "test@docmost.com",
        "DOCMOST_PASSWORD": "test"
      }
    }
  }
}

发展

# Watch mode
npm run watch

# Build
npm run build

许可证

麻省理工学院