Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ private String eventFrame(JSONRPCMessage message) {
private static PrintWriter startEventStream(HttpServletResponse response) throws IOException {
response.setContentType(TEXT_EVENT_STREAM);
response.setCharacterEncoding(UTF_8);
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Cache-Control", "no-cache, no-transform");
response.setHeader("X-Accel-Buffering", "no");
response.setStatus(HttpServletResponse.SC_OK);
response.flushBuffer();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/*
* Copyright 2026-2026 the original author or authors.
*/

package io.modelcontextprotocol.server.transport;

import jakarta.servlet.http.HttpServletResponse;

/**
* Utility methods for working with {@link HttpServletResponse}. For internal use only.
*
* @author Daniel Garnier-Moiroux
*/
final class HttpServletResponseUtils {

private static final String TEXT_EVENT_STREAM = "text/event-stream";

private static final String UTF_8 = "UTF-8";

private HttpServletResponseUtils() {
}

/**
* Prepares the response for streaming Server-Sent Events: sets the content type,
* character encoding and the headers that keep intermediaries from caching,
* transforming or buffering the stream.
* @param response The HTTP servlet response
*/
static void prepareSseResponse(HttpServletResponse response) {
response.setContentType(TEXT_EVENT_STREAM);
response.setCharacterEncoding(UTF_8);
response.setHeader("Cache-Control", "no-cache, no-transform");
response.setHeader("X-Accel-Buffering", "no");
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -300,10 +300,7 @@ protected void doGet(HttpServletRequest request, HttpServletResponse response)
return;
}

response.setContentType("text/event-stream");
response.setCharacterEncoding(UTF_8);
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Connection", "keep-alive");
HttpServletResponseUtils.prepareSseResponse(response);

String sessionId = UUID.randomUUID().toString();
AsyncContext asyncContext = request.startAsync();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -426,10 +426,7 @@ protected void doGet(HttpServletRequest request, HttpServletResponse response)
McpTransportContext transportContext = this.contextExtractor.extract(request);

try {
response.setContentType(TEXT_EVENT_STREAM);
response.setCharacterEncoding(UTF_8);
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Connection", "keep-alive");
HttpServletResponseUtils.prepareSseResponse(response);

AsyncContext asyncContext = request.startAsync();
asyncContext.setTimeout(0);
Expand Down Expand Up @@ -601,10 +598,7 @@ else if (message instanceof McpSchema.JSONRPCNotification jsonrpcNotification) {
}
else if (message instanceof McpSchema.JSONRPCRequest jsonrpcRequest) {
// For streaming responses, we need to return SSE
response.setContentType(TEXT_EVENT_STREAM);
response.setCharacterEncoding(UTF_8);
response.setHeader("Cache-Control", "no-cache");
response.setHeader("Connection", "keep-alive");
HttpServletResponseUtils.prepareSseResponse(response);

AsyncContext asyncContext = request.startAsync();
asyncContext.setTimeout(0);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,9 @@ void streamingToolCallReturnsSse() throws Exception {
assertThat(response.statusCode()).isEqualTo(200);
assertThat(response.headers().firstValue("Content-Type"))
.hasValueSatisfying(v -> assertThat(v).contains("text/event-stream"));
assertThat(response.headers().firstValue("Cache-Control")).contains("no-cache, no-transform");
assertThat(response.headers().firstValue("X-Accel-Buffering")).contains("no");
assertThat(response.headers().firstValue("Connection")).isEmpty();
assertThat(response.body()).contains("notifications/progress");
assertThat(response.body()).contains("\"result\"");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,29 @@ void testRejectsWhenContentLengthHeaderExceedsLimit(String clientType) {
}
}

@Test
void sseResponseHasStreamingHeaders() throws Exception {
prepareAsyncServerBuilder().build();

var httpClient = HttpClient.newHttpClient();
var sseRequest = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:" + PORT + CUSTOM_SSE_ENDPOINT))
.header("Accept", "text/event-stream")
.GET()
.build();

var response = httpClient.send(sseRequest, HttpResponse.BodyHandlers.ofInputStream());
try {
assertThat(response.headers().firstValue("Content-Type")).contains("text/event-stream;charset=UTF-8");
assertThat(response.headers().firstValue("Cache-Control")).contains("no-cache, no-transform");
assertThat(response.headers().firstValue("X-Accel-Buffering")).contains("no");
assertThat(response.headers().firstValue("Connection")).isEmpty();
}
finally {
response.body().close();
}
}

@Test
void rejectsWhenBodyBytesExceedLimitWithoutContentLengthHeader() throws Exception {
var httpClient = HttpClient.newHttpClient();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import java.net.http.HttpResponse;
import java.nio.ByteBuffer;
import java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.Queue;
import java.util.concurrent.CompletableFuture;
Expand Down Expand Up @@ -212,10 +213,72 @@ void testMissingHandlerReturnsMethodNotFoundError() {
}
}

@Test
void listeningStreamHasStreamingHeaders() throws Exception {
prepareAsyncServerBuilder().serverInfo("test-server", "1.0.0").build();
var sessionId = initializeSession(httpClient);

var get = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:" + PORT + MESSAGE_ENDPOINT))
.header("Accept", "text/event-stream")
.header(HttpHeaders.MCP_SESSION_ID, sessionId)
.GET()
.build();

var response = httpClient.send(get, HttpResponse.BodyHandlers.ofInputStream());
try {
assertSseHeaders(response);
}
finally {
response.body().close();
}
}

@Test
void toolCallSseResponseHasStreamingHeaders() throws Exception {
prepareAsyncServerBuilder().serverInfo("test-server", "1.0.0")
.capabilities(McpSchema.ServerCapabilities.builder().tools(true).build())
.tools(McpServerFeatures.AsyncToolSpecification.builder()
.tool(McpSchema.Tool.builder("echo", EMPTY_JSON_SCHEMA).description("returns immediately").build())
.callHandler((exchange,
request) -> Mono.just(McpSchema.CallToolResult.builder()
.content(List.of(McpSchema.TextContent.builder("ok").build()))
.isError(false)
.build()))
.build())
.build();
var sessionId = initializeSession(httpClient);

var post = HttpRequest.newBuilder()
.uri(URI.create("http://localhost:" + PORT + MESSAGE_ENDPOINT))
.header("Content-Type", "application/json")
.header("Accept", "text/event-stream, application/json")
.header(HttpHeaders.MCP_SESSION_ID, sessionId)
.POST(HttpRequest.BodyPublishers
.ofString("{\"jsonrpc\":\"2.0\",\"id\":\"call-1\",\"method\":\"tools/call\","
+ "\"params\":{\"name\":\"echo\",\"arguments\":{}}}"))
.build();

var response = httpClient.send(post, HttpResponse.BodyHandlers.ofInputStream());
try {
assertSseHeaders(response);
}
finally {
response.body().close();
}
}

@Override
protected void prepareClients(int port, String mcpEndpoint) {
}

private static void assertSseHeaders(HttpResponse<?> response) {
assertThat(response.headers().firstValue("Content-Type")).contains("text/event-stream;charset=UTF-8");
assertThat(response.headers().firstValue("Cache-Control")).contains("no-cache, no-transform");
assertThat(response.headers().firstValue("X-Accel-Buffering")).contains("no");
assertThat(response.headers().firstValue("Connection")).isEmpty();
}

static McpTransportContextExtractor<HttpServletRequest> TEST_CONTEXT_EXTRACTOR = (r) -> McpTransportContext
.create(Map.of("important", "value"));

Expand Down
Loading