​
关于 MCP 服务器

MCP（Model Context Protocol，模型上下文协议）是一种开放协议，用于在 AI 应用与外部服务（如文档）之间建立标准化连接。Mintlify 会基于你的文档和 OpenAPI 规范生成一个 MCP 服务器，为更广泛的 AI 生态做好准备，使任何 MCP 客户端（如 Claude、Cursor、Goose 等）都可以连接到你的文档和 API。 你的 MCP 服务器会向 AI 应用提供工具，用于搜索你的文档并与 API 交互。

​
访问你的 MCP 服务器

MCP 服务器仅能为公开文档生成。需要终端用户登录验证的文档无法用于生成服务器。
Mintlify 会为你的文档自动生成一个 MCP 服务器，并将其托管在你的文档 URL 下的 /mcp 路径。例如，Mintlify 的 MCP 服务器可通过 https://mintlify.com/docs/mcp 访问。 你可以在仪表盘中查看并复制你的 MCP 服务器 URL。 /mcp 路径保留用于托管的 MCP 服务器，不能用于其他导航元素。

​
配置 MCP 服务器

所有 MCP 服务器默认包含 search 工具，允许用户在其他工具中查询您文档中的信息。 如果您订阅了 Pro 或 Enterprise 方案，可以将 OpenAPI 规范中的端点公开为 MCP 工具。 要将端点公开为 MCP 工具，请在文件级或端点级的 x-mint 扩展中使用 mcp 对象。例如，Mintlify 的 MCP 服务器包含用于创建助手会话、获取状态更新和触发更新的工具。 MCP 服务器采用安全优先的策略，API 端点默认不公开。您必须显式启用端点，才能将其作为 MCP 工具使用。仅公开在通过 AI 工具对外访问时也安全的端点。
​
mcp
object
该端点的 MCP 配置。

​
文件级配置

在一个 OpenAPI 规范文件中为所有端点默认启用 MCP，并按需排除特定端点： 
{
  "openapi": "3.1.0",
  "x-mint": {
    "mcp": {
      "enabled": true
    }
  },
  // ...
  "paths": {
    "/api/v1/users": {
      "get": {
        "x-mint": {
          "mcp": {
            "enabled": false // 为该端点禁用 MCP
          }
        },
        // ...
      }
    }
  }
}

​
端点级配置

为特定端点启用 MCP： 
{
  "paths": {
    "/api/v1/users": {
      "get": {
        "x-mint": {
          "mcp": {
            "enabled": true,
            "name": "get-users",
            "description": "获取用户列表"
          },
          // ...
        }
      }
    },
    "/api/v1/delete": {
      "delete": {
        // 未包含 `x-mint: mcp`，因此该端点不会作为 MCP 工具对外暴露
        // ...
      }
    }
  }
}

​
使用您的 MCP 服务器

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

​
示例：连接 Mintlify MCP 服务器

连接 Mintlify MCP 服务器以与 Mintlify API 交互并搜索我们的文档。这将为你在本地环境中如何使用 Mintlify 提供更准确的答案，并演示如何帮助你的用户连接到你的 MCP 服务器。
在本页顶部打开上下文菜单，选择 Connect to Cursor 或 Connect to VS Code，将 Mintlify MCP 服务器连接到你选择的 IDE。

​
身份验证

当你为 MCP 启用某个 API 端点时，服务器会采用你在 OpenAPI 的 securitySchemes 和 securityRequirement 中定义的身份验证要求。任何密钥都由工具直接处理，Mintlify 不会存储或处理这些信息。 如果用户让其 AI 工具调用受保护的端点，工具会在当下向用户请求所需的身份验证凭据。

​
监控 MCP 服务器

你可以在仪表盘的 MCP Server 页面 的“Available tools”部分查看所有可用的 MCP 工具。
突出显示“Available tools”部分的 MCP 仪表盘

​
疑难解答