# GitBook MCP 辅助开发

{% hint style="info" %}
遇到 API 接入问题时，可登录 [Eva](https://www.atriptech.com/) 寻求帮助。
{% endhint %}

用这页把 GitBook MCP 接入到你的 AI 工具中。

它适合在 Atlas 集成开发和排障时使用。

### 如何获取 GitBook MCP

GitBook MCP 不需要向 Atlas 单独申请。

先确认两件事：

* 你使用的 AI 工具支持 MCP
* 你的 GitBook 账号可以访问当前文档空间

然后在你的 AI 工具中添加这个 MCP 服务地址：

```
https://resources.atriptech.com/~gitbook/mcp
```

满足以上条件后，使用有当前文档访问权限的 GitBook 账号完成授权。

授权完成后，AI 才能读取你有权限访问的文档内容。

### 常见接入方式

不同 AI 工具的界面会有差异。

但接入步骤通常一致：

1. 打开工具里的 MCP 配置入口。
2. 新增一个 MCP 服务。
3. 填入服务地址 `https://resources.atriptech.com/~gitbook/mcp`。
4. 使用可访问当前文档的 GitBook 账号完成授权。

如果你的工具支持通过配置文件添加 MCP 服务，可参考这个示例：

```json
{
  "mcpServers": {
    "gitbook": {
      "url": "https://resources.atriptech.com/~gitbook/mcp"
    }
  }
}
```

{% hint style="info" %}
不同工具的字段名可能略有不同。

如果你的工具不是用 `url` 字段，按该工具的 MCP 配置格式填写同一个服务地址即可。
{% endhint %}

### 接入前先确认什么

开始前先检查：

* 你已登录正确的 GitBook 账号
* 该账号已能打开当前 Atlas 文档
* 你的 AI 工具已开启 MCP 功能

如果以上任一条件不满足，AI 通常无法读取当前文档上下文。

{% hint style="info" %}
GitBook MCP 的可见范围取决于你的文档访问权限。AI 只能访问你当前账号本来就能访问的内容。
{% endhint %}

### 适合什么场景

GitBook MCP 适合这些任务：

* 基于当前文档生成请求示例
* 对照接口要求解释报错
* 梳理搜索、验价、下单、支付和 webhook 链路
* 在改代码前快速核对字段、标识符和流程顺序

### 它能带来什么

使用 GitBook MCP 时，AI 可以直接读取你当前可访问的文档上下文。

这样生成的答案更容易贴近实际接口约束。

常见用途包括：

* 生成首版集成代码
* 补全请求头、参数和字段映射
* 根据错误码和流程上下文辅助排障

### 什么时候用

推荐在这些阶段使用：

* 开始沙箱开发时
* 联调报错时
* 整理 webhook 处理逻辑时
* 进入 UAT 前自查流程覆盖时

### 使用边界

GitBook MCP 适合辅助开发。

它不能替代真实联调和结果验证。

仍应以实际请求结果为准，重点确认：

* 响应字段和状态
* webhook 事件接收结果
* 支付成功和失败路径
* 沙箱与生产环境差异

{% hint style="info" %}
即使 AI 已生成代码或给出结论，仍要用真实沙箱请求完成验证。
{% endhint %}

### 推荐使用方式

建议你把 GitBook MCP 用在这些工作流里：

1. 先让 AI 基于当前文档生成最小可运行请求。
2. 再用沙箱实际调用验证响应和状态流转。
3. 出现偏差时，让 AI 带着报错和上下文继续分析。

### 如果无法接入

可按这个顺序检查：

1. 确认 AI 工具是否支持 MCP。
2. 确认当前 GitBook 账号是否能正常打开这套文档。
3. 确认授权时使用的是同一个 GitBook 账号。
4. 如果文档访问权限不足，请联系对接人补齐权限。

如果你遇到 Atlas API 接入问题，也可以继续通过 [Eva](https://www.atriptech.com/) 获取帮助。

### 常见问题排查

#### 已连接，但 AI 读不到文档

优先检查：

* 当前授权账号是否就是你平时查看文档的 GitBook 账号
* 该账号是否仍有当前文档空间权限
* AI 工具是否要求重新授权后才会刷新访问范围

#### 地址已填，但无法建立连接

优先检查：

* MCP 地址是否完整且未被改写
* 本地网络或代理是否拦截了该地址
* AI 工具当前版本是否已启用 MCP 功能

#### 能读取文档，但回答不准确

这通常不是接入失败。

优先检查：

* 提问时是否明确指出当前任务阶段
* 是否提供了报错、请求示例或关键标识符
* 是否让 AI 先基于当前文档梳理流程，再生成代码

更稳定的提问方式：

* 先给出目标接口或流程阶段
* 再给出真实报错或响应片段
* 最后要求 AI 输出最小修改建议

### 与沙箱开发配合

在沙箱开发阶段，建议优先让 AI 帮你核对这些内容：

* 请求头是否完整
* `routingIdentifier`、`sessionId` 和 `orderNo` 是否正确保存
* 预订链路顺序是否正确
* webhook 回调后的后续处理是否完整

### 下一步

如果你正在进行实际联调，请继续看 [沙箱开发](/api-wen-dang/ji-cheng-zhi-nan/quick-start/sha-xiang-kai-fa.md)。


---

# Agent Instructions: 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:

```
GET https://resources.atriptech.com/api-wen-dang/ji-cheng-zhi-nan/gitbook-mcp-fu-zhu-kai-fa.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
