mcp已发布文档的 MCP 服务器

在 GitBook 上发布的文档会自动生成一个 MCP 服务器,你可以将其连接到外部工具

每个已发布的 GitBook 站点都会自动包含一个模型上下文协议(MCP)服务器。

AI 工具可以用它直接读取你已发布的文档。这适用于 Claude Desktop、Cursor 和 VS Code 扩展等工具。

你的 MCP 服务器地址是你的已发布站点 URL 加上 /~gitbook/mcp.

例如,GitBook 的文档位于 https://gitbook.com/docs。它的 MCP 服务器是 https://gitbook.com/docs/~gitbook/mcp.

对于公开站点、所有已发布内容都可见的分享链接站点,以及完全通过身份验证的站点,请使用此端点。

对于完全通过身份验证的站点,MCP 客户端会先通过 MCP 发现和 OAuth 流程完成身份验证,然后才能访问工具。更多详情,请参阅 MCP 授权流程arrow-up-right.

如果你的站点是部分身份验证,且仍然暴露公开内容或分享链接内容,请改用 /~gitbook/mcp/auth 。例如, https://gitbook.com/docs/~gitbook/mcp/auth.

circle-info

如果你在浏览器中打开此 URL,你会看到错误。请在能够发出 HTTP 请求的工具中使用它,例如 AI 助手或 IDE。

连接 AI 工具

1

查找你的 MCP 服务器 URL

获取你已发布的 GitBook 站点 URL,并添加与你站点匹配的端点:

  • 使用 /~gitbook/mcp 适用于公开站点、所有已发布内容都可见的分享链接站点,或使用 MCP 发现和 OAuth 的完全身份验证站点。

  • 使用 /~gitbook/mcp/auth 如果你的站点是部分身份验证,且仍然暴露公开内容或分享链接内容。

2

配置你的 AI 工具

将 MCP 服务器 URL 添加到你的 AI 助手设置中。每个工具的设置流程略有不同,因此你应查看所选工具的文档,了解如何为其配置 MCP 服务器。

3

开始使用你的文档

连接后,你的 AI 助手可以搜索你的文档、检索特定页面,并使用你的内容回答问题。该助手将实时访问你已发布的文档。

circle-info

页面操作 必须启用,MCP 服务器才能正常工作。如果你关闭 站点自定义页面操作,GitBook 会禁用 ~gitbook/mcp ,并且该端点将返回 404. 使用 MCP 服务器连接 仅控制 MCP 链接是否显示在页面操作菜单中。

1

查找你的 MCP 服务器 URL

获取你已发布的 GitBook 站点 URL。然后添加 /~gitbook/mcp.

2

配置你的 AI 工具

打开你工具的 MCP 设置。然后输入服务器 URL。

每个工具的设置方式都不同。请查看你所用工具的文档以获取具体步骤。

3

开始使用你的文档

连接后,该工具可以搜索你的文档、打开页面,并用你的内容回答问题。

要求

MCP 服务器会遵循你站点的可见性设置。请使用 /~gitbook/mcp 适用于公开站点、所有已发布内容都可见的分享链接站点,或使用 MCP 发现和 OAuth 的完全身份验证站点。请使用 /~gitbook/mcp/auth 如果你的站点是部分身份验证,且仍然暴露公开内容或分享链接内容。

页面操作 的部分中 自定义 设置中,你可以启用 使用 MCP 服务器连接 选项。这样,访问你文档站点的访客就可以直接从 页面操作菜单.

要使用 MCP 服务器:

  • 你的站点必须已发布。MCP 服务器仅公开已发布内容。

  • 页面操作 必须在 站点自定义页面操作.

  • 你的工具必须支持通过 HTTP 的 MCP。

  • 如果你的站点使用身份验证访问,MCP 服务器会使用相同的访问规则。

  • 如果你的站点使用分享链接,请使用分享链接站点 URL,然后添加 /~gitbook/mcp.

  • GitBook 仅支持 HTTP 传输。 stdioSSE 不受支持。

将 MCP 链接添加到你的站点

站点自定义,打开 页面操作。确保 页面操作 已开启。然后开启 使用 MCP 服务器连接.

如果 页面操作 已关闭,GitBook 会禁用 ~gitbook/mcp ,并且该端点将返回 404.

使用 MCP 服务器连接 仅控制 GitBook 是否在页面操作菜单中显示 MCP 服务器链接。

访客随后就可以从页面操作菜单中复制服务器 URL。

隐私与访问

请确保你使用的是正确的 URL 格式。请使用 /~gitbook/mcp 适用于公开站点、所有已发布内容都可见的分享链接站点,或使用 MCP 发现和 OAuth 的完全身份验证站点。请使用 /~gitbook/mcp/auth 适用于包含公开内容或分享链接内容的部分身份验证站点。

MCP 服务器为你已发布的文档提供只读访问。

隐藏页面仍可通过 MCP 访问。隐藏页面只会将其从已发布的目录中移除。

它绝不会暴露账户数据、分析数据或 GitBook 内部数据。

它只提供最新的已发布版本。草稿和未发布的更改仍保持私密。

故障排除

如果某个工具无法连接:

  • 确认你已发布的站点可访问。

  • 确认 URL 以 /~gitbook/mcp.

  • 如果该站点使用身份验证,请使用支持 MCP 授权规范arrow-up-right.

  • 如果该工具需要 stdioSSE,它将无法与 GitBook 配合使用。

在已验证站点中使用 MCP

如果你的 GitBook 站点使用 身份验证访问,位于 /~gitbook/mcp 的 MCP 服务器会使用相同的身份验证。支持 MCP 授权规范arrow-up-right ——包括 Claude 和 Claude Code——的 MCP 客户端可以使用 OAuth 和动态客户端注册(DCR)自动连接到服务器。

如果你的站点改用分享链接,MCP 仍然可用。使用完整的分享链接站点 URL,然后添加 /~gitbook/mcp.

GitBook 不支持仅使用分享链接的站点,也不支持将访客身份验证令牌作为静态请求头用于 MCP 身份验证的站点。

如果你的站点使用 身份验证访问,MCP 服务器会使用相同的访问规则。公开站点保持公开。受保护站点需要相同的登录。

受支持的 MCP 客户端——包括 Claude——会遵循 MCP 授权规范arrow-up-right 进行连接。

1

发现 OAuth 服务器

在 MCP 握手过程中,客户端会发现你站点的 OAuth 服务器。

2

通过 DCR 注册客户端

客户端通过动态客户端注册注册一个 OAuth 客户端。

你无需手动创建客户端 ID。

3

使用你站点的身份验证提供方登录

客户端会将你重定向到你站点的身份验证提供方。

你使用文档站点已在使用的同一提供方登录。

4

将代码兑换为令牌

登录后,客户端会将授权码兑换为访问令牌。

5

重复使用令牌

客户端会在后续 MCP 请求中携带该令牌,直到它过期。

此流程适用于以下已验证访问后端:

circle-exclamation

要进行设置,请从以下内容开始: 已验证访问启用身份验证访问.

最后更新于

这有帮助吗?