Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.server.transport

Class HttpServletStatelessServerTransport

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

io.modelcontextprotocol.server.transport.HttpServletStatelessServerTransport

All Implemented Interfaces:

McpStatelessServerTransport, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

@WebServlet(asyncSupported=true)
public class HttpServletStatelessServerTransport
extends jakarta.servlet.http.HttpServlet
implements McpStatelessServerTransport

Implementation of an HttpServlet based McpStatelessServerTransport.

Author:

Christian Tzolov, Dariusz Jędrzejczyk

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpServletStatelessServerTransport.Builder	Builder for creating instances of HttpServletStatelessServerTransport.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCEPT
static final String	APPLICATION_JSON
static final String	FAILED_TO_SEND_ERROR_RESPONSE
static final String	TEXT_EVENT_STREAM
static final String	UTF_8

Fields inherited from class jakarta.servlet.http.HttpServlet

LEGACY_DO_HEAD

Method Summary

Modifier and Type	Method	Description
static HttpServletStatelessServerTransport.Builder	builder()	Create a builder for the server.
reactor.core.publisher.Mono<Void>	closeGracefully()	Gracefully closes all the transports with connected clients and releases any associated resources asynchronously.
void	destroy()	Cleans up resources when the servlet is being destroyed.
protected void	doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handles GET requests - returns 405 METHOD NOT ALLOWED as stateless transport doesn't support GET requests.
protected void	doPost(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handles POST requests for incoming JSON-RPC messages from clients.
void	setMcpHandler(McpStatelessServerHandler mcpHandler)

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPatch, doPut, doTrace, getLastModified, init, isSensitiveHeader, service, service

Methods inherited from class jakarta.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.modelcontextprotocol.spec.McpStatelessServerTransport

close, protocolVersions

Field Details

UTF_8

public static final String UTF_8

See Also:

• Constant Field Values

APPLICATION_JSON

public static final String APPLICATION_JSON

See Also:

• Constant Field Values

TEXT_EVENT_STREAM

public static final String TEXT_EVENT_STREAM

See Also:

• Constant Field Values

ACCEPT

public static final String ACCEPT

See Also:

• Constant Field Values

FAILED_TO_SEND_ERROR_RESPONSE

public static final String FAILED_TO_SEND_ERROR_RESPONSE

See Also:

• Constant Field Values

Method Details

setMcpHandler

public void setMcpHandler(McpStatelessServerHandler mcpHandler)

Specified by:

setMcpHandler in interface McpStatelessServerTransport

closeGracefully

public reactor.core.publisher.Mono<Void> closeGracefully()

Description copied from interface: McpStatelessServerTransport

Gracefully closes all the transports with connected clients and releases any associated resources asynchronously.

Specified by:

closeGracefully in interface McpStatelessServerTransport

Returns:

a reactor.core.publisher.Mono<Void> that completes when the connections have been closed.

doGet

protected void doGet(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
              throws jakarta.servlet.ServletException,
IOException

Handles GET requests - returns 405 METHOD NOT ALLOWED as stateless transport doesn't support GET requests.

Overrides:

doGet in class jakarta.servlet.http.HttpServlet

Parameters:

request - The HTTP servlet request

response - The HTTP servlet response

Throws:

jakarta.servlet.ServletException - If a servlet-specific error occurs

IOException - If an I/O error occurs

doPost

protected void doPost(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
               throws jakarta.servlet.ServletException,
IOException

Handles POST requests for incoming JSON-RPC messages from clients.

Overrides:

doPost in class jakarta.servlet.http.HttpServlet

Parameters:

request - The HTTP servlet request containing the JSON-RPC message

response - The HTTP servlet response

Throws:

jakarta.servlet.ServletException - If a servlet-specific error occurs

IOException - If an I/O error occurs

destroy

public void destroy()

Cleans up resources when the servlet is being destroyed.

This method ensures a graceful shutdown before calling the parent's destroy method.

Specified by:

destroy in interface jakarta.servlet.Servlet

Overrides:

destroy in class jakarta.servlet.GenericServlet

builder

public static HttpServletStatelessServerTransport.Builder builder()

Create a builder for the server.

Returns:

a fresh HttpServletStatelessServerTransport.Builder instance.