serving
Serving a Server over a duplex message stream (stdio, SSE, custom sockets).
serve_stream is the driver for stream transports. A server offers both
protocol eras on every connection; the client's opening messages decide the
connection's era, in receive order, and that era serves every later message.
serve_stream
async
serve_stream(
server: Server[LifespanT],
read_stream: ReadStream[SessionMessage | Exception],
write_stream: WriteStream[SessionMessage],
*,
initialization_options: (
InitializationOptions | None
) = None,
lifespan_state: LifespanT | _Unset = _UNSET,
raise_exceptions: bool = False,
task_status: TaskStatus[None] = TASK_STATUS_IGNORED
) -> None
Serve server over a duplex message stream until the read side closes.
The driver for stream transports: the client's opening messages decide the
connection's era. Enters server.lifespan() unless lifespan_state is
given.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
initialization_options
|
InitializationOptions | None
|
The legacy handshake's |
None
|
lifespan_state
|
LifespanT | _Unset
|
An already-entered lifespan state, for several connections sharing one lifespan. |
_UNSET
|
raise_exceptions
|
bool
|
Also re-raise handler exceptions out of this call after the peer has been answered (an in-process testing aid). |
False
|
Source code in src/mcp/server/serving.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | |
serve_legacy_stream
async
serve_legacy_stream(
server: Server[LifespanT],
read_stream: ReadStream[SessionMessage | Exception],
write_stream: WriteStream[SessionMessage],
*,
lifespan_state: LifespanT,
session_id: str | None = None
) -> None
Serve a stream the transport has already routed to the legacy handshake era.
Transport-internal (the streamable-HTTP manager's stateful sessions are born legacy); not part of the author-facing surface.
Source code in src/mcp/server/serving.py
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | |
serve_listener
async
serve_listener(
server: Server[LifespanT],
listener: Listener[ByteStream],
) -> None
Serve every connection listener accepts, over the stdio wire, until cancelled.
Enters the server's lifespan once (shared by every connection), frames each
accepted byte stream with newline_json_transport, and drives it with
serve_stream; takes ownership of listener and closes it on the way out.
listener = await anyio.create_unix_listener("/tmp/mcp.sock")
await serve_listener(server, listener)
Caveat: subscriptions/listen streams belong to the shared server, so
one connection's disconnect gracefully ends the open listen streams of
every connection this server is serving.
Source code in src/mcp/server/serving.py
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | |