创建工作区工具

接口用途

创建工作区自定义 HTTP API 工具。

请求方式

POST

接口地址

https://moi.matrixorigin.cn/newmoi/workspaces/<workspace_id>/tools

身份认证

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

路径参数

无。

查询参数

无。

请求体

创建工作区自定义工具(如 HTTP API 工具)。外部 REST「单独执行工具」入口未稳定确认,创建后主要用于绑定到智能体。

字段

类型

必填

说明

name

string

工具名

description

string

描述

status

string

状态

kind

string

类型,如 http

category

string

分类

tags

array

标签

phase

string

阶段

source_ref

object

type / uri / config

input_schema

object

输入 JSON Schema

output_schema

object

输出 JSON Schema

side_effect_class

string

副作用等级

credential_ref

string

凭据引用

metadata

object

元数据

labels

object

标签 map

请求示例

curl -X POST 'https://moi.matrixorigin.cn/newmoi/workspaces/<workspace_id>/tools' \
  -H 'X-API-Key: <WORKSPACE_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{"name":"my_http_tool","description":"Call an internal HTTP API","kind":"http","status":"active","input_schema":{"type":"object","properties":{"q":{"type":"string"}}},"source_ref":{"type":"http","uri":"https://example.com/api","config":{"method":"GET"}}}'

响应说明

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

返回创建的工具:

字段

类型

必填

说明

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

更新时间

使用限制

  • 工具资源可创建,但外部 REST 单独执行工具入口尚未稳定确认。

相关接口