ToolCreate

Payload used to create Tool. Required fields are name, description, type.

nameName (string)required

alias object

anyOf

• string
• null

string

descriptionDescription (string)required

Description of the tool's functionality

typeType (string)required

Tool type

Possible values: [python, agent, workflow]

collection_id object

Identifier of the containing collection.

anyOf

• string
• null

string

Possible values: non-empty

folder_id object

anyOf

• string
• null

string

tags object

anyOf

• string[]
• null

Array [

string

]

function object

Python function schema

anyOf

• PythonFunctionSchema
• null

sourceSource (string)required

inputs object

property name*any

Default value: {}

outputs object

property name*any

Default value: {}

dependenciesstring[]

Default value: []

decorators object[]

Decorator bindings declared in configuration. Configured bindings take precedence over source bindings with the same kind and name; an empty list uses source bindings only.

Array [

decoratorDecorator (string)required

Decorator name, such as use_connector or use_llm. The name must identify a supported decorator.

nameName (string)required

Binding variable name injected into the namespace

arguments object

Decorator arguments, e.g. {'ref':...} or {'model':...}

property name*any

Decorator arguments, e.g. {'ref':...} or {'model':...}

]

ref object

Referenced agent or pipeline name (for agent/workflow types)

anyOf

• string
• null

string

is_builtinIs Builtin (boolean)

Whether this is a built-in tool

Default value: false

require_browserRequire Browser (boolean)

Whether this tool needs a browser sidecar at agent deploy

Default value: false

examples object[]

Worked call examples surfaced to the LLM as few-shot guidance

Array [

description object

anyOf

• string
• null

string

arguments objectrequired

property name*any

]

options object

anyOf

• object
• null

object

ToolCreate

{
  "name": "string",
  "alias": "string",
  "description": "string",
  "type": "python",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "function": {
    "source": "string",
    "inputs": {},
    "outputs": {},
    "dependencies": [
      "string"
    ],
    "decorators": [
      {
        "decorator": "string",
        "name": "string",
        "arguments": {}
      }
    ]
  },
  "ref": "string",
  "is_builtin": false,
  "require_browser": false,
  "examples": [
    {
      "description": "string",
      "arguments": {}
    }
  ],
  "options": {}
}