> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/zh/gai-shu.md).

# 概述

{% columns %}
{% column width="33.33333333333333%" %}

## 在不到 5 分钟内发布你的文档

使用 GitBook 发布你的文档，就像向你的代理提问一样简单

<a href="https://app.gitbook.com/" class="button primary">注册</a><a href="https://www.gitbook.com/enterprise" class="button secondary">获取演示</a>
{% endcolumn %}

{% column width="66.66666666666667%" %}
{% code overflow="wrap" expandable="true" %}

```markdown
# GitBook 设置代理

## 目标
让我的文档在已发布的 GitBook 站点上上线。完成的标准 = 你把在线 URL 给我，并确认它能加载。凡是需要我操作的步骤，请明确告诉我——其他事情都你来做。

**首先，检查你的工具：**如果 gitbook MCP 工具已经连接，请跳过下面的连接步骤。这个提示可能之前已经粘贴过（例如，在重启之后）——如果是这样，请从上次中断的地方继续，而不是重新开始。

## 准备（立即开始）
向我要文档——本地文件夹或仓库。构建前先验证来源：准确回显你正在读取的内容，并列出其顶层内容，这样我可以确认它是正确的。如果你无法访问我指定的某个内容（私有仓库会返回 404，和不存在的一样），就停下来问我——绝不要用别的来源替代。在 GitBook 中创建任何内容之前，先把站点方案给我看。

## 连接
连接到 GitBook 的 MCP 服务器：`https://mcp.gitbook.com/mcp`（可流式 HTTP，OAuth）。

- **Claude Code**：`claude plugin marketplace add GitbookIO/gitbook-skills` 然后 `claude plugin install gitbook@gitbook-skills` —— 我会运行 `/reload-plugins` 和 `/mcp` 来登录。
- **Codex**：`codex mcp add gitbook --url https://mcp.gitbook.com/mcp`
- **Cursor**：将 URL 添加到 `.cursor/mcp.json` 的 `mcpServers` 下，然后我会在 Settings → MCP 中启用它。
- **没有终端的聊天应用**：告诉我在应用设置中把该 URL 添加为自定义连接器。
- **其他任何情况**：获取 https://gitbook.com/docs/getting-started/ai-documentation/gitbook-mcp.md 以查看设置说明，或使用来自 https://app.gitbook.com/account/developer 的 PAT 回退到 REST API。

大多数工具不会在会话中途加载新的 MCP 服务器。如果设置后 gitbook 工具仍未出现，请让我重启应用并再次粘贴此提示——你会检测到连接并继续。如果你可以运行命令，还可以安装 GitBook 的技能：`npx -y skills add GitbookIO/gitbook-skills -y`

如果由于我没有账户而登录失败，请引导我去 https://app.gitbook.com/join 创建一个，然后让我重试。

## 创建前检查
连接后，检查这些文档是否已经有 GitBook 站点——查看仓库的 Git Sync 状态并列出我组织的站点。如果站点已经存在，不要重复创建：改为更新它（如果 Git Sync 已接通，就在本地编辑并推送，或发起变更请求）。只有在不存在任何站点时才创建新站点。

## 构建并发布
使用 GitBook MCP 工具创建站点，导入我的内容，并发布。第一次发布先跳过 Git Sync——等站点上线后再向我提供这个选项。获取在线 URL 以确认它能加载，然后把它给我。

```

{% endcode %}

<p align="center"><a href="claude://code/new?q=%23%20GitBook%20Setup%20Agent%0AGet%20my%20docs%20live%20on%20a%20published%20GitBook%20site.%20Done%20%3D%20you%20give%20me%20the%20live%20URL%20and%20confirm%20it%20loads.%20Tell%20me%20when%20a%20step%20needs%20me%3B%20do%20the%20rest%20yourself.%0AAsk%20for%20my%20docs%20%28folder%20or%20repo%29.%20Echo%20what%20you%20read%20and%20list%20its%20top%20contents%20so%20I%20can%20confirm.%20If%20a%20source%20is%20unreachable%20%28private%20repos%20return%20404%29%2C%20stop%20and%20ask%20-%20never%20substitute%20another.%20Show%20me%20the%20site%20plan%20before%20creating%20anything.%0AConnect%20%28skip%20if%20gitbook%20MCP%20tools%20already%20available%29%3A%0Aclaude%20plugin%20marketplace%20add%20GitbookIO%2Fgitbook-skills%0Aclaude%20plugin%20install%20gitbook%40gitbook-skills%0AThen%20I%20run%20%2Freload-plugins%20and%20%2Fmcp%20to%20sign%20in.%20If%20tools%20don%27t%20appear%2C%20I%20restart%20and%20paste%20this%20prompt%20again%3B%20detect%20the%20connection%20and%20continue.%0ACheck%20my%20org%20for%20an%20existing%20site%20for%20these%20docs%20first%3B%20if%20found%2C%20update%20it%2C%20don%27t%20duplicate.%0ACreate%20the%20site%20via%20MCP%2C%20import%20content%2C%20publish%20%28no%20Git%20Sync%20yet%3B%20offer%20it%20after%20live%29.%20Verify%20the%20URL%20loads%2C%20then%20share%20it." class="button secondary" data-icon="claude">Claude Code</a><a href="cursor://anysphere.cursor-deeplink/prompt?text=%23%20GitBook%20Setup%20Agent%0AGet%20my%20docs%20live%20on%20a%20published%20GitBook%20site.%20Done%20%3D%20you%20give%20me%20the%20live%20URL%20and%20confirm%20it%20loads.%20Tell%20me%20when%20a%20step%20needs%20me%3B%20do%20the%20rest%20yourself.%0AAsk%20for%20my%20docs%20%28folder%20or%20repo%29.%20Echo%20what%20you%20read%20and%20list%20its%20top%20contents%20so%20I%20can%20confirm.%20If%20a%20source%20is%20unreachable%20%28private%20repos%20return%20404%29%2C%20stop%20and%20ask%20-%20never%20substitute%20another.%20Show%20me%20the%20site%20plan%20before%20creating%20anything.%0AConnect%20%28skip%20if%20gitbook%20MCP%20tools%20already%20available%29%3A%0AAdd%20server%20gitbook%20with%20url%20https%3A%2F%2Fmcp.gitbook.com%2Fmcp%20to%20.cursor%2Fmcp.json%20under%20mcpServers.%20Install%20skills%3A%20npx%20-y%20skills%20add%20GitbookIO%2Fgitbook-skills%20-y%0ACursor%20won%27t%20load%20new%20MCP%20servers%20mid-session%3A%20I%20enable%20it%20in%20Settings%20%3E%20MCP%2C%20sign%20in%2C%20reload%20Cursor%2C%20and%20paste%20this%20prompt%20again%3B%20detect%20the%20connection%20and%20continue.%0ACheck%20my%20org%20for%20an%20existing%20site%20for%20these%20docs%20first%3B%20if%20found%2C%20update%20it%2C%20don%27t%20duplicate.%0ACreate%20the%20site%20via%20MCP%2C%20import%20content%2C%20publish%20%28no%20Git%20Sync%20yet%3B%20offer%20it%20after%20live%29.%20Verify%20the%20URL%20loads%2C%20then%20share%20it." class="button secondary" data-icon="cursor">Cursor</a><a href="codex://threads/new?prompt=%23%20GitBook%20Setup%20Agent%0AGet%20my%20docs%20live%20on%20a%20published%20GitBook%20site.%20Done%20%3D%20you%20give%20me%20the%20live%20URL%20and%20confirm%20it%20loads.%20Tell%20me%20when%20a%20step%20needs%20me%3B%20do%20the%20rest%20yourself.%0AAsk%20for%20my%20docs%20%28folder%20or%20repo%29.%20Echo%20what%20you%20read%20and%20list%20its%20top%20contents%20so%20I%20can%20confirm.%20If%20a%20source%20is%20unreachable%20%28private%20repos%20return%20404%29%2C%20stop%20and%20ask%20-%20never%20substitute%20another.%20Show%20me%20the%20site%20plan%20before%20creating%20anything.%0AConnect%20%28skip%20if%20gitbook%20MCP%20tools%20already%20available%29%3A%0Acodex%20mcp%20add%20gitbook%20--url%20https%3A%2F%2Fmcp.gitbook.com%2Fmcp%0Anpx%20-y%20skills%20add%20GitbookIO%2Fgitbook-skills%20-y%0ANew%20servers%20don%27t%20load%20mid-session%3A%20after%20these%20run%2C%20I%20restart%20Codex%2C%20approve%20sign-in%20in%20my%20browser%2C%20and%20paste%20this%20prompt%20again%3B%20detect%20the%20connection%20and%20continue.%0ACheck%20my%20org%20for%20an%20existing%20site%20for%20these%20docs%20first%3B%20if%20found%2C%20update%20it%2C%20don%27t%20duplicate.%0ACreate%20the%20site%20via%20MCP%2C%20import%20content%2C%20publish%20%28no%20Git%20Sync%20yet%3B%20offer%20it%20after%20live%29.%20Verify%20the%20URL%20loads%2C%20then%20share%20it." class="button secondary" data-icon="openai">Codex</a></p>
{% endcolumn %}
{% endcolumns %}

#### 快速入门指南

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h4><i class="fa-robot">:robot:</i></h4></td><td><strong>AI 快速入门</strong></td><td><a href="/pages/56516e00b90b5da99445020f66866c99ccbd1f96">/pages/56516e00b90b5da99445020f66866c99ccbd1f96</a></td></tr><tr><td><h4><i class="fa-hand-pointer">:hand-pointer:</i></h4></td><td><strong>编辑器快速入门</strong></td><td><a href="/pages/bb2161ff08375554e13a7293ccf2244f1188d4a6">/pages/bb2161ff08375554e13a7293ccf2244f1188d4a6</a></td></tr></tbody></table>

#### 探索 GitBook 的功能

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th></th><th></th><th data-hidden data-card-cover data-type="image">封面图</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-type="image">封面图（深色）</th><th data-hidden data-card-cover-dark data-type="image">封面图（深色）</th></tr></thead><tbody><tr><td><h4>GitBook 代理</h4></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/a47919b6edcf8b0f45ffa22377d52becea6544de">使用 GitBook 代理写作</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/7e087e2d7715580040d4eabdc7a47d4f423fc7bf">审查变更请求</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/53d206db699803a08d5ca7f779ad973e12347916">识别内容缺口</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/c4ffd0f6fec591ffaf2d4c6e20d3f8ab46fb16c4">频道</a></td><td><a href="/files/e3e588c5f64eadec519ddc463fe24a0f31f99a6e">/files/e3e588c5f64eadec519ddc463fe24a0f31f99a6e</a></td><td><a href="/files/42ecb4ee27da74466c8a8f5475e319067c7417f4">/files/42ecb4ee27da74466c8a8f5475e319067c7417f4</a></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td><h4>GitBook 助手</h4></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/a9dc9d18df80990ad5dbf6aebaa44dfc44f5ace2">连接</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/ff2d19b54e71dd7d496f8b3333b9d83f3af6502e">文档嵌入</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/4842e93523db2270e7ac469a0ea36c7541458277">连接到自定义工具</a></td><td></td><td><a href="/files/fa339a0e755779294b2325d6d1a0a6f304b194ab">/files/fa339a0e755779294b2325d6d1a0a6f304b194ab</a></td><td></td><td><a href="/files/6f0a9b0c7ba444c724fe7ebcd48ab3bf97d534fa">/files/6f0a9b0c7ba444c724fe7ebcd48ab3bf97d534fa</a></td><td></td><td></td><td></td><td></td></tr><tr><td><h4>Git Sync</h4></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/bbae593a3e2e8d6bc142ba025f3d313ba88e003b">启用 GitHub 同步</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/800e55ba5efef4d571fb75722b395ab47fac6b7e">内容配置</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/918abc608d1b6f8db0ec527a6aa2f8875e187fa4">GitHub 拉取请求预览</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/3533c428fd0bcc443f07f7e1252e3aff5c8d9f99">单体仓库</a></td><td><a href="/files/99677134948778169b49e162bc993e6c4eb3cc51">/files/99677134948778169b49e162bc993e6c4eb3cc51</a></td><td></td><td></td><td><a href="/files/bad4fb411c3099c3101adc8e855f74891a1974b9">/files/bad4fb411c3099c3101adc8e855f74891a1974b9</a></td><td></td><td></td><td></td></tr><tr><td><h4>AI 洞察</h4></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/eaa754be2a440632f6d3ebb9fb268ea2fa510e64">AI 洞察</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/9f97be21402fc075995178c6e13cb838c64a90aa">GitBook 助手</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/53d206db699803a08d5ca7f779ad973e12347916">识别内容缺口</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/ca9521754948c849d1bd694a3d3674f1e3456343">站点分析</a></td><td><a href="/files/c7e2a491f1770f953f26bbc2062f30810374f841">/files/c7e2a491f1770f953f26bbc2062f30810374f841</a></td><td></td><td></td><td></td><td><a href="/files/091e74a4832bdb0633e9204c09f29a29452baec7">/files/091e74a4832bdb0633e9204c09f29a29452baec7</a></td><td></td><td></td></tr><tr><td><h4>MCP 服务器</h4></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/edc2cc7343295ecf861f3c6515bedd4884d8baf8">GitBook MCP</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/b4a8a4cbe1c54b4f31675a4dca208e1f709d7eb0">已发布文档的 MCP 服务器</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/dd1c63cc42f33c379dcd4bb26f91c4c7f8a96204">AI 编码助手与 skill.md</a></td><td><a href="/spaces/seQcoxgdFQZ5VpT0z87G/pages/f0dbf78b97cf3a2ffd12e43dff1717b4cdede857">面向 AI 优化</a></td><td><a href="/files/05433dab2b9d1809fa9f468c7b20b4397a39f5e5">/files/05433dab2b9d1809fa9f468c7b20b4397a39f5e5</a></td><td></td><td></td><td></td><td></td><td><a href="/files/4a6ae91b9e3a38b5173de195b49969d230a7d95b">/files/4a6ae91b9e3a38b5173de195b49969d230a7d95b</a></td><td></td></tr><tr><td><h4>API</h4></td><td><a href="/spaces/2SyQSbIa1iYS7z6Dx5di/pages/fPDrhpoBpT2XvowhteEg">GitBook API</a></td><td><a href="/spaces/2SyQSbIa1iYS7z6Dx5di/pages/6OzUWR95VKSzFiOfDRak">快速入门</a></td><td><a href="/spaces/2SyQSbIa1iYS7z6Dx5di/pages/RUvdmIKeuCU1QCU5Uett">API 参考</a></td><td></td><td><a href="/files/53aa2bb26158d26cbc28bca8deec3dfc3586e44f">/files/53aa2bb26158d26cbc28bca8deec3dfc3586e44f</a></td><td></td><td></td><td></td><td></td><td></td><td><a href="/files/bfb0ec1ee76eee840cb815118a5acbdc299b3a47">/files/bfb0ec1ee76eee840cb815118a5acbdc299b3a47</a></td></tr></tbody></table>

#### 在找其他内容？

<button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">提问…</button>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/documentation/zh/gai-shu.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.