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.

circle-info

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

连接 AI 工具

1

查找你的 MCP 服务器 URL

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

2

配置你的 AI 工具

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

不同工具的设置方式各不相同。请查看你的工具文档了解具体步骤。

3

开始使用你的文档

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

要求

要使用 MCP 服务器:

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

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

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

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

将 MCP 链接添加到你的网站

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

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

隐私与访问

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

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

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

故障排除

如果某个工具无法连接:

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

  • 确认 URL 以 /~gitbook/mcp.

  • 如果该网站使用身份验证,请使用支持 MCP 授权的客户端。

  • 如果工具需要 stdioSSE,它将无法与 GitBook 一起使用。

在已验证的网站上使用 MCP

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

工作原理

当受支持的 MCP 客户端连接到你已验证网站的 MCP 服务器时,它会:

  1. 通过 MCP 握手发现 OAuth 服务器

  2. 动态注册 OAuth 客户端(无需手动设置客户端 ID)

  3. 将你重定向到网站的上游身份验证提供方以登录

  4. 将授权码交换为访问令牌,并将其本地存储以供后续所有请求使用

你第一次连接时,GitBook 会提示你进行身份验证。之后,客户端会重复使用该令牌,直到它过期。

要求

要使此流程正常工作,你的网站必须使用 GitBook 支持的以下身份验证后端之一:

  • Auth0、Azure AD、Okta、AWS Cognito,或通过原生集成的 OIDC

  • 配置了 Fallback URL 的自定义后端

GitBook 不支持仅使用分享链接的网站,或使用作为静态请求头传递的访客身份验证令牌进行 MCP 身份验证的网站。

最后更新于

这有帮助吗?