@deskcreate/agentcraft
Preparing search index...
adapters
ToolDefinition
Interface ToolDefinition
interface
ToolDefinition
{
description
:
string
;
name
:
string
;
parameters
:
{
properties
:
Record
<
string
,
{
description
?:
string
;
enum
?:
string
[]
;
type
:
string
}
,
>
;
required
:
string
[]
;
type
:
"object"
;
}
;
security
?:
{
requiresConfirmation
?:
boolean
;
scopes
?:
string
[]
;
sideEffect
:
"none"
|
"read"
|
"write"
|
"external"
;
}
;
execute
(
args
:
Record
<
string
,
unknown
>
)
:
Promise
<
unknown
>
;
}
Index
Properties
description
name
parameters
security?
Methods
execute
Properties
description
description
:
string
name
name
:
string
parameters
parameters
:
{
properties
:
Record
<
string
,
{
description
?:
string
;
enum
?:
string
[]
;
type
:
string
}
,
>
;
required
:
string
[]
;
type
:
"object"
;
}
Optional
security
security
?:
{
requiresConfirmation
?:
boolean
;
scopes
?:
string
[]
;
sideEffect
:
"none"
|
"read"
|
"write"
|
"external"
;
}
Methods
execute
execute
(
args
:
Record
<
string
,
unknown
>
)
:
Promise
<
unknown
>
Parameters
args
:
Record
<
string
,
unknown
>
Returns
Promise
<
unknown
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
description
name
parameters
security
Methods
execute
@deskcreate/agentcraft
Loading...