MCP TypeScript SDK
V2 Docs
Preparing search index...
experimental
ToolTaskHandler
Interface ToolTaskHandler<Args>
Experimental
Interface for task-based tool handlers.
interface
ToolTaskHandler
<
Args
extends
undefined
|
ZodRawShapeCompat
|
AnySchema
=
undefined
,
>
{
createTask
:
BaseToolCallback
<
{
_meta
?:
{
"io.modelcontextprotocol/related-task"
?:
{
taskId
:
string
}
;
progressToken
?:
string
|
number
;
[
key
:
string
]:
unknown
;
}
;
task
:
{
createdAt
:
string
;
lastUpdatedAt
:
string
;
pollInterval
?:
number
;
status
:
|
"working"
|
"input_required"
|
"completed"
|
"failed"
|
"cancelled"
;
statusMessage
?:
string
;
taskId
:
string
;
ttl
:
number
|
null
;
}
;
[
key
:
string
]:
unknown
;
}
,
CreateTaskRequestHandlerExtra
,
>
;
getTask
:
BaseToolCallback
<
{
_meta
?:
{
"io.modelcontextprotocol/related-task"
?:
{
taskId
:
string
}
;
progressToken
?:
string
|
number
;
[
key
:
string
]:
unknown
;
}
;
createdAt
:
string
;
lastUpdatedAt
:
string
;
pollInterval
?:
number
;
status
:
|
"working"
|
"input_required"
|
"completed"
|
"failed"
|
"cancelled"
;
statusMessage
?:
string
;
taskId
:
string
;
ttl
:
number
|
null
;
}
,
TaskRequestHandlerExtra
,
>
;
getTaskResult
:
BaseToolCallback
<
{
_meta
?:
{
"io.modelcontextprotocol/related-task"
?:
{
taskId
:
string
}
;
progressToken
?:
string
|
number
;
[
key
:
string
]:
unknown
;
}
;
content
:
(
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
text
:
string
;
type
:
"text"
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
data
:
string
;
mimeType
:
string
;
type
:
"image"
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
data
:
string
;
mimeType
:
string
;
type
:
"audio"
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
description
?:
string
;
icons
?:
{
mimeType
?:
string
;
sizes
?:
string
[]
;
src
:
string
;
theme
?:
"light"
|
"dark"
;
}
[]
;
mimeType
?:
string
;
name
:
string
;
title
?:
string
;
type
:
"resource_link"
;
uri
:
string
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
resource
:
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
mimeType
?:
string
;
text
:
string
;
uri
:
string
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
blob
:
string
;
mimeType
?:
string
;
uri
:
string
;
}
;
type
:
"resource"
;
}
)
[]
;
isError
?:
boolean
;
structuredContent
?:
{
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
,
TaskRequestHandlerExtra
,
>
;
}
Type Parameters
Args
extends
undefined
|
ZodRawShapeCompat
|
AnySchema
=
undefined
Index
Properties
create
Task
get
Task
get
Task
Result
Properties
Experimental
create
Task
createTask
:
BaseToolCallback
<
{
_meta
?:
{
"io.modelcontextprotocol/related-task"
?:
{
taskId
:
string
}
;
progressToken
?:
string
|
number
;
[
key
:
string
]:
unknown
;
}
;
task
:
{
createdAt
:
string
;
lastUpdatedAt
:
string
;
pollInterval
?:
number
;
status
:
|
"working"
|
"input_required"
|
"completed"
|
"failed"
|
"cancelled"
;
statusMessage
?:
string
;
taskId
:
string
;
ttl
:
number
|
null
;
}
;
[
key
:
string
]:
unknown
;
}
,
CreateTaskRequestHandlerExtra
,
>
Experimental
get
Task
getTask
:
BaseToolCallback
<
{
_meta
?:
{
"io.modelcontextprotocol/related-task"
?:
{
taskId
:
string
}
;
progressToken
?:
string
|
number
;
[
key
:
string
]:
unknown
;
}
;
createdAt
:
string
;
lastUpdatedAt
:
string
;
pollInterval
?:
number
;
status
:
|
"working"
|
"input_required"
|
"completed"
|
"failed"
|
"cancelled"
;
statusMessage
?:
string
;
taskId
:
string
;
ttl
:
number
|
null
;
}
,
TaskRequestHandlerExtra
,
>
Experimental
get
Task
Result
getTaskResult
:
BaseToolCallback
<
{
_meta
?:
{
"io.modelcontextprotocol/related-task"
?:
{
taskId
:
string
}
;
progressToken
?:
string
|
number
;
[
key
:
string
]:
unknown
;
}
;
content
:
(
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
text
:
string
;
type
:
"text"
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
data
:
string
;
mimeType
:
string
;
type
:
"image"
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
data
:
string
;
mimeType
:
string
;
type
:
"audio"
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
description
?:
string
;
icons
?:
{
mimeType
?:
string
;
sizes
?:
string
[]
;
src
:
string
;
theme
?:
"light"
|
"dark"
;
}
[]
;
mimeType
?:
string
;
name
:
string
;
title
?:
string
;
type
:
"resource_link"
;
uri
:
string
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
audience
?:
(
"user"
|
"assistant"
)
[]
;
lastModified
?:
string
;
priority
?:
number
;
}
;
resource
:
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
mimeType
?:
string
;
text
:
string
;
uri
:
string
;
}
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
blob
:
string
;
mimeType
?:
string
;
uri
:
string
;
}
;
type
:
"resource"
;
}
)
[]
;
isError
?:
boolean
;
structuredContent
?:
{
[
key
:
string
]:
unknown
}
;
[
key
:
string
]:
unknown
;
}
,
TaskRequestHandlerExtra
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
create
Task
get
Task
get
Task
Result
V2 Docs
MCP TypeScript SDK
Loading...
Interface for task-based tool handlers.