批量创建 MCP 工具

将已探测或已保存的 MCP 连接中的工具批量创建为工作区工具。

POST https://api.moi.matrixorigin.cn/v5/workspaces/{workspace_id}/connections/actions/batch-create-mcp-tools

调用前准备

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

请求体

curl -X POST "https://api.moi.matrixorigin.cn/v5/workspaces/$WORKSPACE_ID/connections/actions/batch-create-mcp-tools" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "connection_id": "'"$CONNECTION_ID"'",
    "items": [
      {
        "tool_name": "search_docs",
        "name": "搜索文档"
      }
    ]
  }'

字段

类型

是否必填

说明

connection_id

string

否

已保存的 MCP 连接 ID。

name

string

否

新建连接的名称。

endpoint_uri

string

否

新建连接的 MCP 服务地址。

transport

string

否

MCP 传输方式。

auth_type

string

否

认证类型。

api_key_header

string

否

API Key 使用的请求头名称。

credential

object

否

MCP 凭据。

visibility

string

否

新建连接的可见范围。

items

object(对象数组)

是

要创建的 MCP 工具列表。

items[].tool_name

string

是

MCP 服务发现的工具名称。

items[].name

string

否

本地工具名称。省略时使用发现的工具名称。

items[].description

string

否

工具说明。

items[].input_schema

object

否

工具输入 Schema。

items[].output_schema

object

否

工具输出 Schema。

items[].tags

string(字符串数组)

否

工具标签。

items[].category

string

否

工具分类。

批量创建前会重新发现上游工具。当前发现结果会覆盖提交的说明、输入 Schema 和输出 Schema。上游工具定义以当前发现结果为准。

成功响应

{
  "code": 0,
  "data": {
    "connection": {
      "id": "id_example",
      "workspace_id": "workspace_example",
      "name": "",
      "status": "draft",
      "kind": "model_api",
      "endpoint_uri": "",
      "auth_type": "none",
      "visibility": "private",
      "version": 1,
      "created_at": "2026-10-14T00:00:00Z",
      "updated_at": "2026-10-14T00:00:00Z"
    },
    "connection_status": "created",
    "items": []
  }
}

字段

类型

说明

code

integer

请求处理成功时为 0。

data

object

响应数据。

data.connection

object

连接信息。

data.connection.id

string

对象 ID。

data.connection.workspace_id

string

所属工作区 ID。

data.connection.name

string

名称。

data.connection.description

string

说明。未设置时可省略。

data.connection.status

string

当前状态。取值:draft、active、disabled、archived。

data.connection.kind

string

连接类型。取值:model_api、huggingface、mcp_server、http_api、external_drive、object_storage、database、webhook、channel。

data.connection.endpoint_uri

string

服务端点地址。

data.connection.auth_type

string

认证方式。取值:none、api_key、bearer_token、oauth2、basic、custom_headers、service_account、client_certificate。

data.connection.credential_ref

string

已保存凭据的引用,不是明文密钥。未设置时可省略。

data.connection.capabilities

string(字符串数组)

可用能力列表。未设置时可省略。

data.connection.owner_user_id

string

所属用户标识。未设置时可省略。

data.connection.visibility

string

可见范围。取值:private、workspace。

data.connection.config

object

非敏感配置,字段随连接或通道类型变化。未设置时可省略。

data.connection.last_test_status

string

最近测试状态,取 succeeded 或 failed。未设置时可省略。取值:succeeded、failed。

data.connection.last_tested_at

string

最近测试时间,采用 RFC 3339 格式。未设置时可省略。

data.connection.last_test_error

string

最近测试的错误说明。未设置时可省略。

data.connection.version

integer

当前版本号。

data.connection.labels

object

标签键值对。未设置时可省略。

data.connection.annotations

object

扩展注解。未设置时可省略。

data.connection.metadata

object

扩展元数据。未设置时可省略。

data.connection.created_by

string

创建者标识。未设置时可省略。

data.connection.updated_by

string

最近更新者标识。未设置时可省略。

data.connection.created_at

string

创建时间,采用 RFC 3339 格式。

data.connection.updated_at

string

最近更新时间,采用 RFC 3339 格式。

data.connection_status

object

连接状态。取值:created、existing、failed。

data.items

object(对象数组)

批量创建结果。

data.items[].tool_name

string

工具名称。

data.items[].status

object

当前状态。取值:created、existing、failed。

data.items[].tool

object

创建或复用的工具。未设置时可省略。

data.items[].tool.id

string

对象 ID。

data.items[].tool.workspace_id

string

所属工作区 ID。

data.items[].tool.name

string

名称。

data.items[].tool.description

string

说明。未设置时可省略。

data.items[].tool.display_name

string

展示名称。

data.items[].tool.display_description

string

展示说明。未设置时可省略。

data.items[].tool.status

string

当前状态。取值:draft、active、disabled、archived。

data.items[].tool.kind

string

连接类型。取值:system、mcp、http_api、operator、market、code。

data.items[].tool.category

string

资源分类。未设置时可省略。

data.items[].tool.icon_ref

string

图标引用。未设置时可省略。

data.items[].tool.tags

string(字符串数组)

标签列表。未设置时可省略。

data.items[].tool.phase

string

处理阶段。未设置时可省略。

data.items[].tool.market_metadata

object

市场展示元数据。未设置时可省略。

data.items[].tool.source_ref

object

来源引用。

data.items[].tool.source_ref.type

string

操作类型。未设置时可省略。

data.items[].tool.source_ref.id

string

对象 ID。未设置时可省略。

data.items[].tool.source_ref.uri

string

资源地址。未设置时可省略。

data.items[].tool.source_ref.version

string

当前版本号。未设置时可省略。

data.items[].tool.source_ref.config

object

非敏感配置,字段随连接或通道类型变化。未设置时可省略。

data.items[].tool.input_schema

object

输入参数的 JSON Schema。未设置时可省略。

data.items[].tool.output_schema

object

输出结果的 JSON Schema。未设置时可省略。

data.items[].tool.side_effect_class

string

副作用分类。取值:read、write、external_effect。

data.items[].tool.credential_ref

string

已保存凭据的引用,不是明文密钥。未设置时可省略。

data.items[].tool.approval_policy_ref

string

审批策略引用。未设置时可省略。

data.items[].tool.redaction_policy_ref

string

脱敏策略引用。未设置时可省略。

data.items[].tool.sync

object

同步结果。

data.items[].tool.sync.status

string

当前状态。未设置时可省略。

data.items[].tool.sync.last_sync_at

string

最近同步时间。未设置时可省略。

data.items[].tool.sync.last_sync_error

string

最近同步的错误说明。未设置时可省略。

data.items[].tool.version

integer

当前版本号。

data.items[].tool.labels

object

标签键值对。未设置时可省略。

data.items[].tool.annotations

object

扩展注解。未设置时可省略。

data.items[].tool.metadata

object

扩展元数据。未设置时可省略。

data.items[].tool.bindable

boolean

是否可绑定。

data.items[].tool.bindability_reason

string

是否可绑定的原因说明。未设置时可省略。

data.items[].tool.supported_runtimes

string(字符串数组)

支持的运行方式。未设置时可省略。

data.items[].tool.created_by

string

创建者标识。未设置时可省略。

data.items[].tool.updated_by

string

最近更新者标识。未设置时可省略。

data.items[].tool.created_at

string

创建时间,采用 RFC 3339 格式。

data.items[].tool.updated_at

string

最近更新时间,采用 RFC 3339 格式。

data.items[].error

object

错误详情。未设置时可省略。

data.items[].error.code

string

错误代码。

data.items[].error.message

string

操作说明。

错误响应

{
  "code": 2,
  "message": "invalid request"
}

字段

类型

说明

code

integer

错误代码。

message

string

面向调用者的错误信息。

最后更新于