# 保存 GitHub 工具连接

为当前工作区保存 GitHub 工具连接。请求中的访问令牌只用于建立或更新凭据，成功响应不会回显令牌。

```text
POST https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/tools/github/connect
```

## 调用前准备

准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：要保存连接的工作区 ID，通过 `X-Workspace-ID` Header 传递。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 当前工作区 ID。 |

## 请求体

| 字段 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `access_token` | string | 是 | GitHub 访问令牌本身，不要包含 `Bearer ` 前缀。令牌不能含首尾空白、换行或路径分隔符。 |

## 请求示例

```bash
curl -X POST "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/tools/github/connect" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "access_token": "<GITHUB_ACCESS_TOKEN>"
  }'
```

## 成功响应

成功时返回 `200`。重新连接会更新工作区中的 GitHub 连接。

```json
{
  "code": 0,
  "data": {
    "tool_id": "moi.github.tools",
    "credential_ref": "cred_01",
    "status": "connected",
    "connected_at": "2026-01-02T15:04:05Z",
    "requires_reconnect": false
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.tool_id` | string | GitHub 内置工具标识。 |
| `data.credential_ref` | string | 已保存凭据的引用，不是访问令牌。 |
| `data.status` | string | 连接状态；新连接为 `connected`。 |
| `data.connected_at` | string | 建立连接的时间，使用 RFC 3339 格式。 |
| `data.requires_reconnect` | boolean | 是否需要重新连接；新连接为 `false`。 |

## 错误响应

```json
{
  "code": 2,
  "message": "<错误信息>"
}
```

### 常见 HTTP 错误

```{list-table}
:header-rows: 1
:widths: 12 22 32 34

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - 请求体无效，或访问令牌为空、包含 `Bearer ` 前缀、换行或不允许的字符。
  - 提交令牌值本身，并检查字段格式。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有在工作区中管理工具连接的权限。
  - 检查工作区授权。
* - `503`
  - `15`（`UNAVAILABLE`）
  - GitHub 工具连接服务或授权依赖暂不可用。
  - 稍后重试。
```

## 后续操作

保存后[查询 GitHub 工具连接](get-github-connection.md)确认连接配置。