# 查询工具详情

读取当前工作区工具或可读取的系统工具，详情响应包含输入和输出 Schema。

```text
GET https://moi.matrixorigin.cn/newmoi/workspaces/{workspace_id}/tools/{tool_id}
```

## 调用前准备

先[查询工具列表](list-tools.md)取得工具 ID。准备有目标工作区访问权限的个人访问令牌和目标工作区 ID。

下方示例使用：

- `$AI_STUDIO_API_KEY`：实际个人访问令牌，通过 `X-API-Key` Header 传递。
- `$WORKSPACE_ID`：目标工作区 ID，通过 `X-Workspace-ID` Header 传递。
- `$TOOL_ID`：要查询的工具 ID。

## 路径参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `workspace_id` | string | 是 | 当前工作区 ID。 |
| `tool_id` | string | 是 | 要查询的工具 ID。 |

## 查询参数

| 参数 | 类型 | 是否必填 | 说明 |
| --- | --- | --- | --- |
| `tool_workspace_id` | string | 否 | 工具所属工作区 ID。未提供时使用当前工作区；只能指定当前工作区或系统工作区。 |

## 请求示例

```bash
curl "https://moi.matrixorigin.cn/newmoi/workspaces/$WORKSPACE_ID/tools/$TOOL_ID" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"
```

## 成功响应

成功时返回 `200`。

```json
{
  "code": 0,
  "data": {
    "id": "tool_01",
    "workspace_id": "ws_01",
    "name": "查询工具",
    "status": "active",
    "kind": "http_api",
    "input_schema": {},
    "output_schema": {},
    "side_effect_class": "read",
    "version": 1,
    "bindable": true,
    "supported_runtimes": []
  }
}
```

响应字段如下。

| 字段 | 类型 | 说明 |
| --- | --- | --- |
| `code` | integer | 成功时为 `0`。 |
| `data.id` | string | 工具 ID、所属工作区和名称。 |
| `data.workspace_id` | string | 工具 ID、所属工作区和名称。 |
| `data.name` | string | 工具 ID、所属工作区和名称。 |
| `data.status` | string | 工具状态、类别和分类。 |
| `data.kind` | string | 工具状态、类别和分类。 |
| `data.category` | string | 工具状态、类别和分类。 |
| `data.input_schema` | object | 工具输入和输出 Schema。 |
| `data.output_schema` | object | 工具输入和输出 Schema。 |
| `data.side_effect_class` | string | 工具的副作用分类。 |
| `data.credential_ref` | string | 凭据、审批和脱敏策略引用；未设置时不返回。 |
| `data.approval_policy_ref` | string | 凭据、审批和脱敏策略引用；未设置时不返回。 |
| `data.redaction_policy_ref` | string | 凭据、审批和脱敏策略引用；未设置时不返回。 |
| `data.bindable` | boolean | 当前绑定能力、不可绑定原因和支持的运行环境。 |
| `data.bindability_reason` | string | 当前绑定能力、不可绑定原因和支持的运行环境。 |
| `data.supported_runtimes` | string（字符串数组） | 当前绑定能力、不可绑定原因和支持的运行环境。 |
| `data.version` | integer | 工具版本与创建、最近更新时间。 |
| `data.created_at` | string | 工具版本与创建、最近更新时间。 |
| `data.updated_at` | string | 工具版本与创建、最近更新时间。 |

## 错误响应

```json
{
  "code": 3,
  "message": "tool not found"
}
```

### 常见 HTTP 错误

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

* - HTTP 状态码
  - 错误代码
  - 常见原因
  - 建议操作
* - `400`
  - `2`（`INVALID_ARGUMENT`）
  - 路径或 `tool_workspace_id` 无效。
  - 检查路径和查询参数。
* - `401`
  - `6`（`UNAUTHENTICATED`）
  - 缺少有效身份凭据。
  - 检查 API Key。
* - `403`
  - `5`（`PERMISSION_DENIED`）
  - 当前身份没有读取工具的权限。
  - 检查工作区授权。
* - `404`
  - `3`（`NOT_FOUND`）
  - 指定工作区范围内不存在该工具。
  - 检查工具 ID 和所属工作区。
* - `503`
  - `15`（`UNAVAILABLE`）
  - 工具资源服务或授权依赖暂不可用。
  - 稍后重试。
```

## 后续操作

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