# 查询 GitHub 工具连接

查询当前工作区的 GitHub 工具连接状态。该接口只返回凭据引用和状态，不返回访问令牌。

```text
GET 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。 |

## 请求示例

```bash
curl "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"
```

## 成功响应

成功时返回 `200`。未保存连接时，接口仍成功返回 `disconnected` 状态。

```json
{
  "code": 0,
  "data": {
    "tool_id": "moi.github.tools",
    "status": "disconnected",
    "requires_reconnect": false
  }
}
```

连接可用时，响应包含凭据引用和建立时间：

```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.status` | string | `connected`、`disconnected` 或 `needs_reconnect`。 |
| `data.credential_ref` | string | 连接可用或需重连时的凭据引用；未连接时不返回。 |
| `data.connected_at` | string | 原连接建立时间；未连接时不返回。 |
| `data.requires_reconnect` | boolean | 凭据已过期时为 `true`。 |

## 错误响应

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

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - 工作区 ID 无效。
  - 检查路径参数。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有读取工具连接的权限。
  - 检查工作区授权。
* - `503`
  - `15`（`UNAVAILABLE`）
  - GitHub 工具连接服务或授权依赖暂不可用。
  - 稍后重试。
```

## 后续操作

需要修改时[更新工具](update-tool.md)。返回列表时[查询工具标签](list-tool-tags.md)。