message_queue
TaskMessageQueue - FIFO queue for task-related messages.
This implements the core message queue pattern from the MCP Tasks spec.
When a handler needs to send a request (like elicitation) during a task-augmented
request, the message is enqueued instead of sent directly. Messages are delivered
to the client only through the tasks/result endpoint.
This pattern enables: 1. Decoupling request handling from message delivery 2. Proper bidirectional communication via the tasks/result stream 3. Automatic status management (working <-> input_required)
QueuedMessage
dataclass
A message queued for delivery via tasks/result.
Messages are stored with their type and a resolver for requests that expect responses.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 | |
type
instance-attribute
type: Literal['request', 'notification']
Whether this is a request (expects response) or notification (one-way).
message
instance-attribute
message: JSONRPCRequest | JSONRPCNotification
The JSON-RPC message to send.
timestamp
class-attribute
instance-attribute
When the message was enqueued.
resolver
class-attribute
instance-attribute
Resolver to set when response arrives (only for requests).
original_request_id
class-attribute
instance-attribute
original_request_id: RequestId | None = None
The original request ID used internally, for routing responses back.
TaskMessageQueue
Bases: ABC
Abstract interface for task message queuing.
This is a FIFO queue that stores messages to be delivered via tasks/result.
When a task-augmented handler calls elicit() or sends a notification, the
message is enqueued here instead of being sent directly to the client.
The tasks/result handler then dequeues and sends these messages through
the transport, with relatedRequestId set to the tasks/result request ID
so responses are routed correctly.
Implementations can use in-memory storage, Redis, etc.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | |
enqueue
abstractmethod
async
enqueue(task_id: str, message: QueuedMessage) -> None
Add a message to the queue for a task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
message
|
QueuedMessage
|
The message to enqueue |
required |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
64 65 66 67 68 69 70 71 | |
dequeue
abstractmethod
async
dequeue(task_id: str) -> QueuedMessage | None
Remove and return the next message from the queue.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
Returns:
| Type | Description |
|---|---|
QueuedMessage | None
|
The next message, or None if queue is empty |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
73 74 75 76 77 78 79 80 81 82 | |
peek
abstractmethod
async
peek(task_id: str) -> QueuedMessage | None
Return the next message without removing it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
Returns:
| Type | Description |
|---|---|
QueuedMessage | None
|
The next message, or None if queue is empty |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
84 85 86 87 88 89 90 91 92 93 | |
is_empty
abstractmethod
async
Check if the queue is empty for a task.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if no messages are queued |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
95 96 97 98 99 100 101 102 103 104 | |
clear
abstractmethod
async
clear(task_id: str) -> list[QueuedMessage]
Remove and return all messages from the queue.
This is useful for cleanup when a task is cancelled or completed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
Returns:
| Type | Description |
|---|---|
list[QueuedMessage]
|
All queued messages (may be empty) |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
106 107 108 109 110 111 112 113 114 115 116 117 | |
wait_for_message
abstractmethod
async
wait_for_message(task_id: str) -> None
Wait until a message is available in the queue.
This blocks until either: 1. A message is enqueued for this task 2. The wait is cancelled
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
119 120 121 122 123 124 125 126 127 128 129 | |
notify_message_available
abstractmethod
async
notify_message_available(task_id: str) -> None
Signal that a message is available for a task.
This wakes up any coroutines waiting in wait_for_message().
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The task identifier |
required |
Source code in src/mcp/shared/experimental/tasks/message_queue.py
131 132 133 134 135 136 137 138 139 | |
InMemoryTaskMessageQueue
Bases: TaskMessageQueue
In-memory implementation of TaskMessageQueue.
This is suitable for single-process servers. For distributed systems, implement TaskMessageQueue with Redis, RabbitMQ, etc.
Features: - FIFO ordering per task - Async wait for message availability - Thread-safe for single-process async use
Source code in src/mcp/shared/experimental/tasks/message_queue.py
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 | |
enqueue
async
enqueue(task_id: str, message: QueuedMessage) -> None
Add a message to the queue.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
164 165 166 167 168 169 | |
dequeue
async
dequeue(task_id: str) -> QueuedMessage | None
Remove and return the next message.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
171 172 173 174 175 176 | |
peek
async
peek(task_id: str) -> QueuedMessage | None
Return the next message without removing it.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
178 179 180 181 182 183 | |
is_empty
async
Check if the queue is empty.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
185 186 187 188 | |
clear
async
clear(task_id: str) -> list[QueuedMessage]
Remove and return all messages.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
190 191 192 193 194 195 | |
wait_for_message
async
wait_for_message(task_id: str) -> None
Wait until a message is available.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | |
notify_message_available
async
notify_message_available(task_id: str) -> None
Signal that a message is available.
Source code in src/mcp/shared/experimental/tasks/message_queue.py
214 215 216 217 | |
cleanup
cleanup(task_id: str | None = None) -> None
Clean up queues and events.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str | None
|
If provided, clean up only this task. Otherwise clean up all. |
None
|
Source code in src/mcp/shared/experimental/tasks/message_queue.py
219 220 221 222 223 224 225 226 227 228 229 230 | |