Docmost MCP Server

MCP文档知识

提供方 aleksvin8888

文档知识 stdio · 本地进程 Token 社区 / 第三方 Claude DesktopClaudeCursorWindsurf
查看接入方式

Docmost MCP Server是一个为AI助手提供自托管文档访问的API服务,支持文档空间管理、全文搜索、页面操作等功能。

一句话选型结论

按资料字段整理

Docmost MCP Server 属于文档知识类 MCP 服务器,stdio · 本地进程,Token,可直接接入 Claude Desktop、Claude、Cursor 等,有可直接复制的远程端点配置。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权Token 部署方式支持远程部署
GitHub 星标 4 仓库热度,无公开仓库时显示未标注
工具数 11 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量11暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

文档管理Python本地部署API服务AI集成自托管全文搜索

安装与配置

stdio · 本地进程 Token
客户端在本机拉起子进程,数据不出本机
python3 -m venv venv

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    确认你的客户端支持远程端点,并拿到服务地址。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 11 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 11 个工具,覆盖面较广,能满足多种调用。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Docmost MCP Server当前 11 stdio · 本地进程 支持远程部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方aleksvin8888上游标注的维护方 aleksvin8888
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式Token远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · Python本地安装时用到的包标识与运行时
部署类型支持远程部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

9.8 KB
来自项目仓库与上游目录的原文,未做删改

Docmost MCP服务器

一 主控程序 服务器,让AI助手直接访问您的自托管 Docmost 通过其API提供文档。

适用于任何MCP兼容客户端,包括:

  • 克劳德代码 / 克劳德桌面
  • 光标
  • 帆板运动
  • VS代码(GitHub副本)
  • 克莱恩
  • 继续
  • 泽德

特性

工具 说明
list_space 列出所有可用的文档空间,包括名称、slug和ID
search_docs 在所有文档中进行全文搜索,并可选择空格过滤
get_page 检索从ProseMirror JSON转换为Markdown的整页内容
create_space 创建一个具有可选幂等行为的新空间
创建页面 在空间中创建页面(Markdown内容)
update_page 更新页面标题/内容(替换/附加/预置模式)
复制_页面 递归复制页面
move_page 在空间或层次结构中移动页面
move_page_to_space 将页面移动到另一个空间
创建注释 创建页面评论(Markdown转换为ProseMirror)
解决方案 使用可选注释解决注释

先决条件

  • Python 3.10+
  • 具有有效用户凭据的正在运行的Docmost实例
  • MCP兼容客户端(克劳德代码、克劳德桌面、光标、VS代码等)

安装

1.克隆存储库```bash

git clone https://github.com/aleksvin8888/local-docmost-mcp.git
cd docmost-mcp


### 2.创建虚拟环境并安装依赖项```bash
python3 -m venv venv
source venv/bin/activate   # Linux / macOS
# venv\Scripts\activate    # Windows

pip install -r requirements.txt

这将安装核心依赖项:

  • mcp --用于构建MCP服务器的官方Python SDK
  • requests -用于Docmost API调用的HTTP客户端

3.使用Docker进行本地开发(可选)

如果你需要一个本地Docmost实例进行测试,你可以使用提供的Docker Compose设置:```bash
cd container_docmost
docker compose up -d


这将启动Docmost `http://localhost:3000` (港口 `3001` 如果在主机映射中配置)以及Postgres和Redis。

### 4.配置凭据

复制示例配置并填写您的详细信息:```bash
cp config.example.json config.json

编辑 config.json:```json
{
"base_url": "https://your-docmost-instance.example.com",
"email": "your-email@example.com",
"password": "your-password",
"timeout": 30,
"page_content_format": "markdown",
"create_space_conflict_policy": "return_existing",
"duplicate_page_conflict_policy": "auto_suffix",
"clear_parent_on_space_move": true
}


|参数|说明|
|-----------|-------------|
| `base_url` |Docmost实例的URL(无尾随斜线)|
| `email` |Docmost身份验证的电子邮件地址|
| `password` |Docmost身份验证密码|
| `timeout` |HTTP请求超时(秒)|
| `page_content_format` |用于创建/更新的页面内容格式(默认值: `markdown`) |
| `create_space_conflict_policy` | `return_existing` 或 `error` 论空间名称冲突|
| `duplicate_page_conflict_policy` | `auto_suffix` 或 `error` 论标题冲突|
| `clear_parent_on_space_move` |移动到另一个空间时清除父级(默认值:true)|

> **注:** `config.json` 包含敏感凭据,并通过以下方式从版本控制中排除 `.gitignore`.

### 4.验证设置```bash
source venv/bin/activate   # if not already active

python docmost_client.py

预期产量:```
=== Spaces ===
My Space (my-space) - 019a2a69-...
Another Space (another) - 019a5e21-...
...

=== Search 'example' ===
Example Page Title - abc123def
...


如果您看到您的空格和搜索结果,则表明客户端工作正常。

## 连接到MCP客户端

服务器使用 **标准** 传输,由所有主要的MCP客户端支持。下面是最受欢迎的设置说明。

### 克劳德代码

选择以下选项之一。

> **重要提示:** 使用 **绝对路径** 内部的Python二进制文件 `venv` 和 `mcp_server.py`.

### 选项1:全局配置(推荐)

添加 `~/.claude/settings.json`:```json
{
"mcpServers": {
"docmost": {
"command": "/absolute/path/to/docmost-mcp/venv/bin/python",
"args": ["/absolute/path/to/docmost-mcp/mcp_server.py"]
}
}
}

选项2:项目级配置

创建 .claude/settings.json 在项目根目录中:```json
{
"mcpServers": {
"docmost": {
"command": "/absolute/path/to/docmost-mcp/venv/bin/python",
"args": ["/absolute/path/to/docmost-mcp/mcp_server.py"]
}
}
}


### 选项3:CLI命令```bash
claude mcp add docmost \
-c "/absolute/path/to/docmost-mcp/venv/bin/python" \
-- /absolute/path/to/docmost-mcp/mcp_server.py

添加配置后,重新启动Claude Code或启动新会话。

克劳德桌面

将服务器添加到Claude Desktop配置文件中:

  • Linux: ~/.config/claude/claude_desktop_config.json
  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • 窗户: `%APPDATA%\Claude\claude_desktop_config.json````json
    {
    "mcpServers": {
    "docmost": {
    "command": "/absolute/path/to/docmost-mcp/venv/bin/python",
    "args": ["/absolute/path/to/docmost-mcp/mcp_server.py"]
    }
    }
    }

保存配置后重新启动Claude Desktop。

### 光标/风帆/VS码/其他客户端

大多数MCP客户端使用相同的配置格式。使用以下命令添加服务器:

- **命令:** `/absolute/path/to/docmost-mcp/venv/bin/python`
- **Args:** `/absolute/path/to/docmost-mcp/mcp_server.py`
- **运输:** 标准

有关配置文件的确切位置和格式,请参阅客户的文档。

## 用法

连接MCP服务器后,您的AI助手可以使用以下工具:

### 列出所有空间```
Show me all available documentation spaces

搜索文档```

Search the documentation for "user permissions"


### 在特定空间内搜索```
Find "API endpoints" in the Engineering space

获取特定页面```

Show me the full content of page with slug_id "abc123def"


### 创建新空间```
Create a space named "Project Phoenix" with description "Q2 launch docs"

创建页面```

Create a page in space "SPACE_ID" titled "Kickoff Notes" with content "# Kickoff\n..."


### 更新页面(附加)```
Append "## Decisions\n- ..." to page "PAGE_ID"

移动页面```

Move page "PAGE_ID" under parent "PARENT_ID" and set position "after:SIBLING_ID"


> **注:** `move_page` 将位置提示传递给Docmost API。如果Docmost版本需要分数索引,则可能需要调整API负载或客户端逻辑。

### 评论和解决```
Add a comment to page "PAGE_ID": "Please review this section."
Resolve comment "COMMENT_ID" with note "Addressed in revision 3."

写入工具错误处理

  • create_space:409冲突返回一个明确的错误或现有空格(请参阅 create_space_conflict_policy).
  • create_page:404表示无效 space_id,400为无效 parent_page_id.
  • update_page:页面缺失时为404;append/prepend需要 content.
  • duplicate_page:404当源页面丢失时;冲突处理取决于 duplicate_page_conflict_policy.
  • move_page:需要 new_parent_page_id 或 new_position;拒绝循环移动;无效位置返回400。
  • create_comment:页面缺失时为404;401如果没有授权。
  • resolve_comment:404当评论缺失时;403如果没有授权。

运作原理

  1. MCP客户端将服务器作为子进程启动,并通过以下方式进行通信 标准 (标准输入/标准输出)。
  2. 在第一次API调用中,服务器使用电子邮件/密码对Docmost实例进行身份验证,并接收 JWT令牌 从 Set-Cookie 头球
  3. 令牌缓存在 token.json 用于后续请求。如果请求返回 401,服务器会自动重新进行身份验证并重试。
  4. 页面内容以如下方式存储在Docmost中 ProseMirror JSON。服务器将其转换为clean 标记语言 (标题、列表、表格、代码块、图像、链接等),然后再将其返回给客户端。

项目结构```

docmost-mcp/
├── .github/workflows/ # CI/CD pipelines (GitHub Actions)
├── container_docmost/ # Docker Compose setup for local testing
├── tests/ # Comprehensive unit test suite
├── mcp_server.py # MCP server (11 tools)
├── docmost_client.py # Docmost API client
├── requirements.txt # Python dependencies
├── config.example.json # Configuration template
├── config.json # Your credentials (not in git)
├── token.json # Cached JWT token (auto-generated)
├── .gitignore
└── README.md


## 测试和CI/CD

该项目包括一个全面的测试套件,涵盖API客户端和MCP服务器处理程序。

### 在本地运行测试```bash
# Install test dependencies
pip install pytest pytest-asyncio responses coverage pytest-cov

# Run all tests
PYTHONPATH=. pytest tests/ -v

# Run tests with coverage report
PYTHONPATH=. pytest tests/ --cov=. --cov-report=term-missing

CI/CD

GitHub操作配置在 .github/workflows/ci.yml 在多个Python版本(3.10、3.11、3.12)中对每个推送和拉取请求自动运行测试。

您可以使用以下命令在本地模拟CI环境 行动:bash act push -W .github/workflows/ci.yml

安全

  • config.json 包含您的凭据-- 永远不要将其提交给git
  • token.json 包含JWT令牌-- 永远不要将其提交给git
  • 这两个文件已在中列出 .gitignore

故障排除

“响应Cookie中没有authToken”

  • 核实一下 email 和 password 在 config.json 是正确的
  • 核实一下 base_url 指向您的Docmost实例

“连接被拒绝”

  • 检查您的Docmost实例是否正在运行且可访问
  • 检查您的网络连接和防火墙规则

“401未经授权”

  • 令牌可能已过期--删除 token.json 它将在下次请求时自动重新创建

MCP工具未出现在客户端中

  • 确保您使用 绝对路径 到 venv/bin/python 和 mcp_server.py
  • 检查虚拟环境是否安装了所有依赖项(pip install -r requirements.txt)
  • 更改配置后重新启动MCP客户端

许可证

麻省理工学院

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Docmost MCP Server 怎么安装?

在客户端按下面的安装命令接入:python3 -m venv venv。装完在客户端配置里引用同一个包或端点。

Docmost MCP Server 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Docmost MCP Server 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Docmost MCP Server 需要 API Key 吗?

资料标注需要Token认证,使用前准备好对应凭据,并按最小权限配置。

Docmost MCP Server 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、Windsurf、Cline;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Docmost MCP Server 能提供哪些能力?

资料显示约 11 个工具;能力标签包括 文档处理、全文搜索、Python、Claude、自托管。具体工具清单以官方文档为准。

Docmost MCP Server 需要什么运行环境?

运行时为 Python;属于本地进程,需要在本机装好运行环境。

Docmost MCP Server 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。