Docus 内置 MCP 服务端

使用说明内容(Markdown格式)

  • 项目简介
    • Docus 项目中集成了一个基于 MCP(Model Context Protocol)的服务端,用于向 LLM 客户端提供文档资源、可执行工具以及提示模板等上下文信息,帮助 AI 助手更高效地访问和理解文档内容。
  • 主要功能点
    • 资源管理:通过 Nuxt Content 机制暴露文档内容,LLM 可查询页面信息与文本内容。
    • 工具注册与执行:内置 MCP 工具如 list-pages 和 get-page,支持浏览、检索和获取指定文档页面的完整内容。
    • 提示模板:支持系统提示与对话逻辑,帮助引导模型在文档场景中给出有用的回答。
    • 多语言支持:对启用的语言环境提供对应收藏与查询模式,支持国际化内容查阅。
    • 与客户端的对接:通过 MCP 客户端连接,使用 JSON-RPC 形式请求读取资源、调用工具和获取页面内容。
  • 安装步骤
    1. 安装并获取项目源码中的依赖(例如使用你常用的包管理工具安装依赖)。
    2. 启动开发服务器(在本项目中,MCP 服务端随 Nuxt 应用一起启动,路由通常位于 /mcp)。
    3. 确认服务器在本地端口可访问,例如 http://localhost:3000,如果在生产环境请按你的部署方式暴露端口。
  • 服务器配置(MCP 客户端与服务端对接所需信息) 为让 MCP 客户端连接并使用该服务端,需提供以下配置信息(JSON 格式): { "serverName": "Docus 内置 MCP 服务端", "command": "pnpm", "args": ["run", "dev"], "notes": "启动 Nuxt 应用以暴露 MCP 服务,MCP 服务默认对外暴露在 /mcp 路径。生产环境请使用正式启动命令并确保端口暴露。" } 说明:以上配置用于指导 MCP 客户端如何启动并连接到服务器。在实际部署中,请使用与你的环境一致的启动命令(如 production 的 start 脚本)和端口配置。MCP 客户端本身不需要代码实现,直接使用该配置连接内置的 /mcp 路由即可。
  • 基本使用方法
    • 启动后,客户端应将 MCP 服务器地址指向本应用的 /mcp 路由,例如 http://localhost:3000/mcp。
    • 使用 list-pages 工具浏览文档结构,获取页面的标题、路径与简要描述。
    • 使用 get-page 工具按路径读取指定页面的完整内容与元信息。
    • 结合返回的内容,LLM 可以将文档内容整合到对话中,回答用户问题或提供代码示例等信息。
    • 如需切换语言环境,请使用支持的 Locale 进行查询,确保前端与后端语言配置的一致性。

服务器信息