WebMCP
Rspress 可以通过浏览器原生 WebMCP API 向浏览器智能体提供文档工具。该功能内置于 core,默认开启。启用 Markdown 生成后即可使用全部六个工具:
rspress.config.ts
设置 webMcp: false 可以关闭 Rspress 内置工具,仍可使用 useWebMcp hook 注册自定义工具。
WebMCP 是实验性功能,需要浏览器在 HTTPS 或 localhost 等安全上下文中启用 document.modelContext。不支持的浏览器仍可正常访问站点。
完整配置项请参阅 AI 配置。
内置工具
路由路径不包含配置项 base,支持查询参数和锚点。
rspress_list_pages 接受 query、lang、version、limit(1–100,默认 50)和 offset(默认 0)。其中 query 匹配页面标题、描述、路由和章节标题。rspress_search_docs 接受 query 和 limit(1–20,默认 10)。
跨源智能体
通过 webMcp.exposedTo 允许指定的安全来源发现工具。
自定义工具
通过 @rspress/core/runtime 导出的 useWebMcp,可以在自定义组件中注册工具,并在组件卸载时自动移除。