DeepFOS 文档 MCP 将文档中心作为只读知识服务提供给 WorkBuddy、TRAE、Codex、Claude Code、Cursor 等支持远程 MCP 的客户端。配置完成后,智能体可以浏览文档目录、搜索知识、读取正文,并获取文档引用的图片。
文档 MCP 由文档站直接提供,使用 Streamable HTTP 连接,无须安装本地软件包,也无须下载文档仓库。
可以复制下方“智能体安装指南”,交给当前客户端中的智能体完成配置;也可以选择对应客户端,复制完整配置并手工安装。
复制包含当前 MCP 地址的安装要求,交给智能体识别并配置当前客户端。令牌缺失时,智能体应向你确认。
开始前,只需要准备以下两项信息:
|
信息 |
示例 |
说明 |
|---|---|---|
|
MCP 服务地址 |
当前文档站地址/api/mcp
|
当前文档站的 Streamable HTTP 接口。上方配置会根据当前打开的站点自动生成完整地址。 |
|
文档访问令牌 |
|
由文档站管理员提供,用于访问文档 MCP,不是 DeepFOS 用户 Token 或 API Key。 |
客户端通过以下请求头传递令牌:
Authorization: Bearer <DOC_MCP_TOKEN>令牌属于访问凭证。不要把真实令牌写入公开文档、项目仓库、聊天记录或截图。能够使用环境变量的客户端,应优先从环境变量读取令牌。
选择客户端后,按照对应说明添加配置。服务地址会根据当前打开的文档站自动生成。
打开 插件 → MCP 服务器 → 配置 MCP,粘贴下方配置;也可以编辑用户级 ~/.workbuddy/mcp.json。将 <DOC_MCP_TOKEN> 替换为管理员提供的令牌,保存后确认服务状态为绿色。
{
"mcpServers": {
"deepfos-docs": {
"type": "http",
"url": "当前文档站地址/api/mcp",
"headers": {
"Authorization": "Bearer <DOC_MCP_TOKEN>"
}
}
}
}连接成功后,应能看到以下四个只读工具:
|
工具 |
用途 |
|---|---|
|
|
浏览文档目录,在不确定资料范围时先定位组件或主题。 |
|
|
按自然语言或关键词搜索相关文档和章节。 |
|
|
读取搜索结果对应的整篇文档或指定章节,支持分页续读。 |
|
|
列出文档或章节引用的图片及公开地址,用于辅助理解界面和操作说明。 |
可以让客户端执行以下验证:
调用 docs_catalog,确认能够返回文档来源和目录。
使用 docs_search 搜索“平台对象与数据隔离”。
对搜索结果调用 docs_read,确认正文非空且包含公开文档地址。
涉及界面或操作说明时,调用 docs_images 获取相关图片。
不确定文档范围时,先使用 docs_catalog 浏览目录。
使用 docs_search 定位候选文档和章节。
使用 docs_read 核对原文,并引用工具返回的文档地址。
涉及界面、配置或操作步骤时,再使用 docs_images 查询相关图片。
默认情况下,目录和搜索只使用当前版本文档。只有明确需要查询旧版资料时,才应在 docs_catalog 或 docs_search 中设置 include_legacy=true。已知历史文档的 document_id 仍可直接用于读取正文和图片。
|
现象 |
处理方式 |
|---|---|
|
无法连接 MCP 地址 |
确认地址以 |
|
返回 |
未提供令牌或令牌不正确。确认请求头为 |
|
返回 |
当前浏览器来源不在允许列表中。标准桌面或服务端 MCP 客户端通常不会携带浏览器 |
|
返回 |
使用了不支持的请求方法。MCP 客户端应通过 Streamable HTTP 发送请求,不能把接口当作普通网页直接打开。 |
|
返回 |
文档站尚未配置 MCP 访问令牌,服务暂未开放。请联系文档站管理员完成服务配置。 |
|
已连接但没有工具 |
刷新或重启客户端,确认连接的是 |
|
搜索不到旧版文档 |
历史文档默认不参与目录和搜索;明确需要旧版资料时设置 |
文档 MCP 只提供目录、搜索、正文和图片引用,不会修改平台配置、业务数据或文档内容。回答业务问题时应以工具返回的原文和公开地址为依据;文档没有说明的内容,不应由客户端自行推测。
回到顶部
咨询热线
