查询工具参数结构

接口用途

查看指定系统工具的参数结构(Schema)。

请求方式

GET

接口地址

https://moi.matrixorigin.cn/newmoi/workspaces/<workspace_id>/tools/moi_github_issues?tool_workspace_id=system

身份认证

使用工作区 API Key,在请求头中携带 X-API-Key: <WORKSPACE_API_KEY>,并设置 Content-Type: application/json

路径参数

无。

查询参数

名称

说明

tool_workspace_id

系统工具传 system

请求体

无请求体。

请求示例

curl -X GET 'https://moi.matrixorigin.cn/newmoi/workspaces/<workspace_id>/tools/moi_github_issues?tool_workspace_id=system' \
  -H 'X-API-Key: <WORKSPACE_API_KEY>' \
  -H 'Content-Type: application/json'

响应说明

除 A2A JSON-RPC 外,多数工作区接口成功响应形如 {"code":0,"data":...};下列字段描述 data(或 HTTP 202 时的 data)。

工具详情即参数结构来源;以 GitHub Issues 为例,input_schema 可包括 owner、repo、number、operation、state 等。完整属性以返回的 JSON Schema 为准。

字段

类型

必填

说明

id

string

工具 ID

workspace_id

string

工作区 ID(系统工具可省略或为 system)

name

string

API 工具名

description

string

描述

display_name

string

显示名

status

string

状态,如 active / disabled / archived

kind

string

工具类型

category

string

分类

tags

array

标签

source_ref

object

type / id / uri / version / config

input_schema

object

输入 JSON Schema

output_schema

object

输出 JSON Schema

side_effect_class

string

副作用等级

credential_ref

string

凭据引用(勿展开明文)

version

integer

版本

metadata

object

扩展元数据

created_at

string

创建时间

updated_at

string

更新时间

使用限制

  • 示例路径使用 moi_github_issues;其他工具替换为实际工具名或 ID。

相关接口