For the complete documentation index, see llms.txt. This page is also available as Markdown.

GitBook MCP

将 AI 编程助手连接到 GitBook,这样它们就能通过 GitBook API 创建站点、打开变更请求并编辑内容

GitBook 提供了一个 MCP 服务器,让 AI 工具可以对你组织中的内容执行操作。

Claude Code、Codex、Cursor 等工具,以及其他 MCP 客户端,都可以用它来创建和配置站点、打开变更请求、起草内容、编辑页面以及重构文档。

要将你的 AI 编码助手连接到 GitBook 的 MCP,你需要服务器 URL、一种身份验证方式,以及一个受支持的 MCP 客户端。下面的各个部分会逐步引导你完成。

需要一个用于已发布文档站点的只读 MCP 服务器吗?GitBook 会自动为你创建一个——参见 已发布文档的 MCP 服务器 了解更多。

GitBook 的 MCP 端点

将你的 MCP 客户端指向:

https://mcp.gitbook.com/mcp

在浏览器中打开此 URL 会返回错误。请在能够发起 HTTP 请求的 MCP 客户端中使用它。

连接你的客户端

在你选择的客户端中添加 GitBook MCP:

在终端中注册该服务器:

claude mcp add --transport http gitbook https://mcp.gitbook.com/mcp

然后使用 claude 启动 Claude Code,并运行 /mcp 完成浏览器登录。

如果你更偏好使用个人访问令牌,请将其作为授权头传入:

claude mcp add --transport http gitbook https://mcp.gitbook.com/mcp \
  --header "Authorization: Bearer <YOUR_TOKEN>"

对 GitBook 的 MCP 进行身份验证

GitBook MCP 支持两种身份验证方式:OAuth 和个人访问令牌。

将你的客户端指向 MCP 服务器 URL。客户端会发现授权服务器、注册自身,并自动打开浏览器登录流程。

如果你使用 OAuth,不要手动添加 bearer token。客户端会在登录过程中获取它。

使用 GitBook 的 MCP

Create and configure a new docs site.
Open a change request and draft content.
Move, rename, or restructure pages across a site.

GitBook MCP 与已发布文档 MCP 的区别

GitBook 有两种 MCP 模式:

  • 已发布文档的 MCP 服务器 让 AI 工具对已发布内容具有只读访问权限。

  • GitBook MCP 通过 GitBook API 让 AI 工具访问你的内容和工作流。

当你希望文档读者和最终用户从已发布文档中查找信息时,请使用已发布文档 MCP。

当你希望团队的代理通过自动化工作流编辑和管理文档时,请使用 GitBook MCP。

常见问题

当我连接 MCP 客户端时,GitBook MCP 支持哪种传输方式?

GitBook MCP 支持可流式 HTTP。

GitBook MCP 不支持 stdioSSE.

如果你的客户端要求额外字段,通常可以留空。

当我把客户端连接到 GitBook MCP 时,需要添加 bearer token 吗?

只有在你使用 个人访问令牌.

进行身份验证时,才需要添加 bearer token。如果你使用 OAuth,请不要手动添加 bearer token。你的客户端会在登录流程中获取它。

为什么我把 GitBook MCP 服务器添加到客户端后,什么都没发生?

是的。这在某些 MCP 客户端中是预期行为。

添加服务器通常只是保存配置。某些客户端只有在首次连接、列出工具或打开 MCP 面板时才会启动身份验证。

为什么我点击 GitBook MCP 的 Authenticate 后没有任何反应?

有些客户端会在短暂延迟后打开浏览器登录流程。

在网络较慢或不稳定时,这个延迟可能会更长。

如果大约一分钟后仍未打开浏览器标签页,请检查你的网络、弹窗设置和默认浏览器。

GitBook MCP 的身份验证流程中会发生什么?

当身份验证成功时,流程通常如下:

  1. 客户端连接到 MCP 服务器。

  2. 你的浏览器会打开登录流程。

  3. 你登录并批准访问。

  4. 客户端会显示服务器已连接,或者 MCP 工具变为可用。

我怎么知道我的客户端是否已成功通过 GitBook MCP 身份验证?

具体信号取决于你的客户端,但结果通常很明显。

大多数客户端会移除身份验证提示、显示服务器已连接,或者让助手列出并调用 MCP 工具。

如果 Authenticate 按钮一直可见且没有工具出现,流程很可能没有完成。

如果 GitBook MCP 身份验证似乎仍然卡住,我应该检查什么?

尝试以下检查:

  • 确认服务器 URL 指向 MCP 端点。

  • 确认客户端使用 HTTP 传输。

  • 在稳定的网络下重试。

  • 如果客户端缓存了失败状态,请移除并重新添加该服务器。

最后更新于

这有帮助吗?