查询工具标签¶

查询一个工具目录中的聚合标签及每个标签对应的工具数量。工作区工具与系统工具分别查询，不会合并在同一响应中。

GET https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/tools/tags

调用前准备¶

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

请求参数¶

调用示例

curl "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/tools/tags?catalog=workspace&status=active" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

参数说明

路径参数

参数	类型	是否必填	说明
`workspace_id`	string	是	用于授权的当前工作区 ID。

查询参数

参数	类型	是否必填	说明
`catalog`	string	否	要查询的目录：`workspace`（默认）仅查询当前工作区，`system` 仅查询系统工具。
`status`	string	否	按工具状态、类别、分类或阶段筛选。
`kind`	string	否	按工具状态、类别、分类或阶段筛选。
`category`	string	否	按工具状态、类别、分类或阶段筛选。
`phase`	string	否	按工具状态、类别、分类或阶段筛选。
`side_effect_class`	string	否	按副作用分类筛选。
`runtime_tool_visibility`	string	否	按运行时可见性或绑定类型筛选。`runtime_tool_binding_type` 仅支持 `agent`。
`runtime_tool_binding_type`	string	否	按运行时可见性或绑定类型筛选。`runtime_tool_binding_type` 仅支持 `agent`。
`query`	string	否	按名称、描述、本地化展示文本或标签搜索后再聚合。

成功响应¶

响应示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "tag": "数据查询",
        "count": 3
      },
      {
        "tag": "运维",
        "count": 1
      }
    ]
  }
}

字段说明

成功时返回 200。items 只包含数量大于零的标签，并按标签名称排序。

响应字段如下。

本文中，字段路径中的 [] 表示数组中的每一项。例如，items[].name 表示 items 数组中每一项的 name 字段。

通用字段

字段	类型	说明
`code`	integer	成功时为 `0`。

基本信息

字段	类型	说明
`items`	array	聚合标签列表。

列表项

下面表格展开响应示例中的 items 数据；每一行是该对象或数组项的一个字段。

字段	类型	说明
`tag`	string	标签名称。
`count`	integer	在本次筛选范围内使用该标签的工具数量。

错误响应¶

响应示例

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

字段说明

常见 HTTP 错误

通用字段

字段	类型	说明
`400`	`2`（`INVALID_ARGUMENT`）	常见原因：`catalog` 或运行时绑定类型不受支持。建议操作：将 `catalog` 设为 `workspace` 或 `system`；绑定类型仅使用 `agent`。
`401`	`6`（`UNAUTHENTICATED`）	常见原因：缺少有效身份凭据。建议操作：检查 API Key。
`403`	`5`（`PERMISSION_DENIED`）	常见原因：当前身份没有读取当前工作区工具目录的权限。建议操作：检查工作区授权。
`503`	`15`（`UNAVAILABLE`）	常见原因：工具资源服务或授权依赖暂不可用。建议操作：稍后重试。

后续操作¶

保存目标项的标识，再查询 GitHub 工具连接。

最后更新于 2026 年 9 月 11 日