Represents a tool within the system, including its configuration, state, and associated retrievers.

data
object
required

Data related to the tool, including runtime, environment variables, and more.

description
string
required

A detailed description of the tool.

name
string
required

The name of the tool.

type
enum<string>
required

The type of tool.

Available options:
function,
rag
_id
string

Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

asdf
string

The schema associated with the tool.

datasourceId
string

Identifier of the datasource associated with the tool.

functionId
string

Identifier of the function associated with the tool.

functionLogs
string

Logs related to the function's execution.

hidden
boolean

Indicates whether the tool is hidden.

icon
object

Icon associated with the tool.

orgId
string

Identifier of the organization to which the tool belongs.

retriever_config
object

Configuration settings for the retriever.

retriever_type
enum<string>

The type of retriever used by the tool.

Available options:
raw,
self_query,
time_weighted,
multi_query
revisionId
string

Identifier of the tool's revision.

state
enum<string>

The current state of the tool.

Available options:
pending,
ready,
error
teamId
string

Identifier of the team to which the tool belongs.