跳转到主要内容

关于 MCP 服务器

Model Context Protocol(MCP,模型上下文协议)是一个开放协议,用于在 AI 应用与外部服务(例如文档)之间建立标准化连接。Mintlify 会基于你的文档生成一个 MCP 服务器,为更广泛的 AI 生态系统做好准备,让任何 MCP 客户端例如 Claude、Cursor、Goose、ChatGPT 等都可以连接到你的文档。 你的 MCP 服务器会向 AI 应用提供一个搜索工具,以便在你的文档中发起搜索请求。你的用户必须将你的 MCP 服务器连接到他们的工具中。

MCP 服务器的工作方式

当某个 AI 工具接入你的文档 MCP 服务器后,它可以直接搜索你的文档,而不是在响应用户提示时执行通用的网页搜索。你的 MCP 服务器会提供对文档站点上所有已建立索引内容的访问权限。
  • LLM 可以在生成回复时主动搜索你的文档,而不仅仅是在被显式请求时才进行搜索。
  • LLM 会根据对话的 context 以及你的文档与当前话题的相关性来决定何时使用搜索工具。
  • 每次调用工具都发生在生成过程中,因此 LLM 会从你的文档中检索最新信息来生成回复。
某些 AI 工具(例如 Claude)同时支持 MCP 和 Skills。MCP 让 AI 能够访问你的文档内容,而 Skills 则指导 AI 如何高效使用这些内容。两者是互补的:MCP 提供数据,Skills 提供指令。
AI 工具可以进行网页搜索,但 MCP 在文档方面具有明显优势。
  • 直接访问文档来源:网页搜索依赖搜索引擎已经索引的内容,这些内容可能过时或不完整。MCP 会直接搜索你当前已索引的文档。
  • 集成式工作流:MCP 允许 AI 在生成回答的过程中执行搜索,而不是先单独进行一次网页搜索。
  • 没有搜索噪音:SEO(搜索引擎优化)和排序算法会影响网页搜索结果。MCP 则会直接访问你的文档内容。

访问你的 MCP 服务器

仅能为公开文档生成 MCP 服务器。需要终端用户认证的文档无法用于生成服务器。
Mintlify 会为你的文档自动生成一个 MCP 服务器,并将其托管在你的文档 URL 的 /mcp 路径下。例如,Mintlify 的 MCP 服务器位于 https://mintlify.com/docs/mcp 你可以在控制台中的 MCP 服务器页面 查看并复制你的 MCP 服务器 URL。
控制台中的 MCP 服务器页面。
托管的 MCP 服务器会在其 URL 中使用 /mcp 路径。其他导航元素不能使用 /mcp 路径。

内容过滤与索引编入

你的 MCP 服务器会搜索 Mintlify 从你的文档存储库中索引编入的内容。文件处理和搜索索引编入决定了可通过 MCP 服务器访问的内容。

使用 .mintignore 进行文件处理

如果文件匹配 .mintignore 中的模式,Mintlify 不会处理或索引它们。这些文件也无法通过你的 MCP 服务器访问。

使用 docs.json 配置搜索索引

默认情况下,Mintlify 只会将包含在 docs.json 导航中的页面编入索引,以便通过你的 MCP 服务器进行搜索。 除非你选择将所有页面都编入索引,否则 Mintlify 会将隐藏页面(不在导航中的页面)排除在搜索索引之外。要在 MCP 服务器的搜索结果中包含隐藏页面,请在 docs.json 中添加 seo.indexing 属性。
"seo": {
    "indexing": "all"
}
要将特定页面排除在搜索索引编入之外,请在其 frontmatter 中添加 noindex: true
---
title: "隐藏页面"
description: "此页面不在导航中,并且无法通过搜索访问。"
noindex: true
---

使用你的 MCP 服务器

你的用户需要将你的 MCP 服务器连接到他们常用的 AI 工具。
  1. 将你的 MCP 服务器 URL 公开可访问。
  2. 让用户复制你的 MCP 服务器 URL 并添加到他们的工具中。
  3. 用户即可通过其工具访问你的文档。
以下是一些你可以帮助用户连接到你的 MCP 服务器的方法:
上下文菜单中为用户添加选项,使其可从文档任意页面连接到你的 MCP 服务器。
选项标识符说明
复制 MCP 服务器 URLmcp将你的 MCP 服务器 URL 复制到用户的剪贴板。
连接到 Cursorcursor在 Cursor 中安装你的 MCP 服务器。
连接到 VS Codevscode在 VS Code 中安装你的 MCP 服务器。

示例:连接 Mintlify MCP 服务器

连接 Mintlify MCP 服务器,以便在你常用的 AI 工具中搜索此文档站点。这样你就能在本地环境中更精准地了解如何使用 Mintlify,同时也演示了如何帮助你的用户连接到你的 MCP 服务器。
在本页顶部打开上下文菜单,选择 Connect to CursorConnect to VS Code,即可将 Mintlify MCP 服务器连接到你选择的 IDE。

使用多个 MCP 服务器

用户可以将多个 MCP 服务器连接到他们的 AI 工具。已连接的 MCP 服务器在 AI 调用搜索工具之前不会消耗上下文。AI 会根据查询的相关性决定何时进行搜索,因此不会为每个问题都搜索所有已连接的服务器。 当 AI 执行搜索时,每次查询都会返回多个结果,并被添加到对话的上下文中。如果 AI 为单个问题搜索多个服务器,就可能会占用大量上下文。 使用多个 MCP 服务器的最佳实践:
  • 只连接与当前工作相关的 MCP 服务器。
  • 在提示中尽量具体,这样 AI 会搜索到最相关的服务器。
  • 断开当前未主动使用的服务器,以减少潜在的上下文占用。