Skip to content

Commit 98e3d8f

Browse files
KehrlannKehrlann
committed
Autoconfigure MCP client with and async HTTP request customizer
Signed-off-by: Daniel Garnier-Moiroux <git@garnier.wf>
1 parent 1256eaf commit 98e3d8f

4 files changed

Lines changed: 205 additions & 13 deletions

File tree

‎auto-configurations/mcp/spring-ai-autoconfigure-mcp-client-httpclient/src/main/java/org/springframework/ai/mcp/client/httpclient/autoconfigure/SseHttpClientTransportAutoConfiguration.java‎

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@
2323

2424
import com.fasterxml.jackson.databind.ObjectMapper;
2525
import io.modelcontextprotocol.client.McpSyncClient;
26+
import io.modelcontextprotocol.client.transport.AsyncHttpRequestCustomizer;
2627
import io.modelcontextprotocol.client.transport.HttpClientSseClientTransport;
28+
import io.modelcontextprotocol.client.transport.SyncHttpRequestCustomizer;
2729
import io.modelcontextprotocol.spec.McpSchema;
2830

2931
import org.springframework.ai.mcp.client.common.autoconfigure.NamedClientMcpTransport;
@@ -36,6 +38,7 @@
3638
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
3739
import org.springframework.boot.context.properties.EnableConfigurationProperties;
3840
import org.springframework.context.annotation.Bean;
41+
import org.springframework.core.log.LogAccessor;
3942

4043
/**
4144
* Auto-configuration for Server-Sent Events (SSE) HTTP client transport in the Model
@@ -68,6 +71,8 @@
6871
matchIfMissing = true)
6972
public class SseHttpClientTransportAutoConfiguration {
7073

74+
private static final LogAccessor logger = new LogAccessor(SseHttpClientTransportAutoConfiguration.class);
75+
7176
/**
7277
* Creates a list of HTTP client-based SSE transports for MCP communication.
7378
*
@@ -77,15 +82,22 @@ public class SseHttpClientTransportAutoConfiguration {
7782
* <li>A new HttpClient instance
7883
* <li>Server URL from properties
7984
* <li>ObjectMapper for JSON processing
85+
* <li>A sync or async HTTP request customizer. Sync takes precedence.
8086
* </ul>
8187
* @param sseProperties the SSE client properties containing server configurations
8288
* @param objectMapperProvider the provider for ObjectMapper or a new instance if not
8389
* available
90+
* @param syncHttpRequestCustomizer provider for {@link SyncHttpRequestCustomizer} if
91+
* available
92+
* @param asyncHttpRequestCustomizer provider fo {@link AsyncHttpRequestCustomizer} if
93+
* available
8494
* @return list of named MCP transports
8595
*/
8696
@Bean
8797
public List<NamedClientMcpTransport> sseHttpClientTransports(McpSseClientProperties sseProperties,
88-
ObjectProvider<ObjectMapper> objectMapperProvider) {
98+
ObjectProvider<ObjectMapper> objectMapperProvider,
99+
ObjectProvider<SyncHttpRequestCustomizer> syncHttpRequestCustomizer,
100+
ObjectProvider<AsyncHttpRequestCustomizer> asyncHttpRequestCustomizer) {
89101

90102
ObjectMapper objectMapper = objectMapperProvider.getIfAvailable(ObjectMapper::new);
91103

@@ -96,11 +108,21 @@ public List<NamedClientMcpTransport> sseHttpClientTransports(McpSseClientPropert
96108
String baseUrl = serverParameters.getValue().url();
97109
String sseEndpoint = serverParameters.getValue().sseEndpoint() != null
98110
? serverParameters.getValue().sseEndpoint() : "/sse";
99-
var transport = HttpClientSseClientTransport.builder(baseUrl)
111+
HttpClientSseClientTransport.Builder transportBuilder = HttpClientSseClientTransport.builder(baseUrl)
100112
.sseEndpoint(sseEndpoint)
101113
.clientBuilder(HttpClient.newBuilder())
102-
.objectMapper(objectMapper)
103-
.build();
114+
.objectMapper(objectMapper);
115+
116+
asyncHttpRequestCustomizer.ifUnique(transportBuilder::asyncHttpRequestCustomizer);
117+
syncHttpRequestCustomizer.ifUnique(transportBuilder::httpRequestCustomizer);
118+
if (asyncHttpRequestCustomizer.getIfUnique() != null && syncHttpRequestCustomizer.getIfUnique() != null) {
119+
logger.warn("Found beans of type %s and %s. Using %s.".formatted(
120+
AsyncHttpRequestCustomizer.class.getSimpleName(),
121+
SyncHttpRequestCustomizer.class.getSimpleName(),
122+
SyncHttpRequestCustomizer.class.getSimpleName()));
123+
}
124+
125+
HttpClientSseClientTransport transport = transportBuilder.build();
104126
sseTransports.add(new NamedClientMcpTransport(serverParameters.getKey(), transport));
105127
}
106128

‎auto-configurations/mcp/spring-ai-autoconfigure-mcp-client-httpclient/src/main/java/org/springframework/ai/mcp/client/httpclient/autoconfigure/StreamableHttpHttpClientTransportAutoConfiguration.java‎

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,14 @@
3131
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
3232
import org.springframework.boot.context.properties.EnableConfigurationProperties;
3333
import org.springframework.context.annotation.Bean;
34+
import org.springframework.core.log.LogAccessor;
3435

3536
import com.fasterxml.jackson.databind.ObjectMapper;
3637

3738
import io.modelcontextprotocol.client.McpSyncClient;
38-
import io.modelcontextprotocol.client.transport.HttpClientSseClientTransport;
39+
import io.modelcontextprotocol.client.transport.AsyncHttpRequestCustomizer;
3940
import io.modelcontextprotocol.client.transport.HttpClientStreamableHttpTransport;
41+
import io.modelcontextprotocol.client.transport.SyncHttpRequestCustomizer;
4042
import io.modelcontextprotocol.spec.McpSchema;
4143

4244
/**
@@ -59,6 +61,7 @@
5961
* connections
6062
* <li>Configures ObjectMapper for JSON serialization/deserialization
6163
* <li>Supports multiple named server connections with different URLs
64+
* <li>Adds a sync or async HTTP request customizer. Sync takes precedence.
6265
* </ul>
6366
*
6467
* @see HttpClientStreamableHttpTransport
@@ -71,6 +74,8 @@
7174
matchIfMissing = true)
7275
public class StreamableHttpHttpClientTransportAutoConfiguration {
7376

77+
private static final LogAccessor logger = new LogAccessor(StreamableHttpHttpClientTransportAutoConfiguration.class);
78+
7479
/**
7580
* Creates a list of HTTP client-based Streamable HTTP transports for MCP
7681
* communication.
@@ -86,11 +91,17 @@ public class StreamableHttpHttpClientTransportAutoConfiguration {
8691
* configurations
8792
* @param objectMapperProvider the provider for ObjectMapper or a new instance if not
8893
* available
94+
* @param syncHttpRequestCustomizer provider for {@link SyncHttpRequestCustomizer} if
95+
* available
96+
* @param asyncHttpRequestCustomizer provider fo {@link AsyncHttpRequestCustomizer} if
97+
* available
8998
* @return list of named MCP transports
9099
*/
91100
@Bean
92101
public List<NamedClientMcpTransport> streamableHttpHttpClientTransports(
93-
McpStreamableHttpClientProperties streamableProperties, ObjectProvider<ObjectMapper> objectMapperProvider) {
102+
McpStreamableHttpClientProperties streamableProperties, ObjectProvider<ObjectMapper> objectMapperProvider,
103+
ObjectProvider<SyncHttpRequestCustomizer> syncHttpRequestCustomizer,
104+
ObjectProvider<AsyncHttpRequestCustomizer> asyncHttpRequestCustomizer) {
94105

95106
ObjectMapper objectMapper = objectMapperProvider.getIfAvailable(ObjectMapper::new);
96107

@@ -103,11 +114,22 @@ public List<NamedClientMcpTransport> streamableHttpHttpClientTransports(
103114
String streamableHttpEndpoint = serverParameters.getValue().endpoint() != null
104115
? serverParameters.getValue().endpoint() : "/mcp";
105116

106-
HttpClientStreamableHttpTransport transport = HttpClientStreamableHttpTransport.builder(baseUrl)
117+
HttpClientStreamableHttpTransport.Builder transportBuilder = HttpClientStreamableHttpTransport
118+
.builder(baseUrl)
107119
.endpoint(streamableHttpEndpoint)
108120
.clientBuilder(HttpClient.newBuilder())
109-
.objectMapper(objectMapper)
110-
.build();
121+
.objectMapper(objectMapper);
122+
123+
asyncHttpRequestCustomizer.ifUnique(transportBuilder::asyncHttpRequestCustomizer);
124+
syncHttpRequestCustomizer.ifUnique(transportBuilder::httpRequestCustomizer);
125+
if (asyncHttpRequestCustomizer.getIfUnique() != null && syncHttpRequestCustomizer.getIfUnique() != null) {
126+
logger.warn("Found beans of type %s and %s. Using %s.".formatted(
127+
AsyncHttpRequestCustomizer.class.getSimpleName(),
128+
SyncHttpRequestCustomizer.class.getSimpleName(),
129+
SyncHttpRequestCustomizer.class.getSimpleName()));
130+
}
131+
132+
HttpClientStreamableHttpTransport transport = transportBuilder.build();
111133

112134
streamableHttpTransports.add(new NamedClientMcpTransport(serverParameters.getKey(), transport));
113135
}

‎auto-configurations/mcp/spring-ai-autoconfigure-mcp-client-httpclient/src/test/java/org/springframework/ai/mcp/client/autoconfigure/SseHttpClientTransportAutoConfigurationIT.java‎

Lines changed: 76 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
/*
2-
* Copyright 2024-2024 the original author or authors.
2+
* Copyright 2024-2025 the original author or authors.
33
*/
44

55
package org.springframework.ai.mcp.client.autoconfigure;
66

77
import static org.assertj.core.api.Assertions.assertThat;
8+
import static org.mockito.ArgumentMatchers.any;
9+
import static org.mockito.Mockito.atLeastOnce;
10+
import static org.mockito.Mockito.mock;
11+
import static org.mockito.Mockito.verify;
12+
import static org.mockito.Mockito.verifyNoInteractions;
13+
import static org.mockito.Mockito.when;
814

915
import java.util.List;
1016

@@ -17,12 +23,19 @@
1723
import org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration;
1824
import org.springframework.ai.mcp.client.httpclient.autoconfigure.SseHttpClientTransportAutoConfiguration;
1925
import org.springframework.boot.autoconfigure.AutoConfigurations;
26+
import org.springframework.boot.context.annotation.UserConfigurations;
2027
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
28+
import org.springframework.context.annotation.Bean;
29+
import org.springframework.context.annotation.Configuration;
30+
2131
import org.testcontainers.containers.GenericContainer;
2232
import org.testcontainers.containers.wait.strategy.Wait;
2333

2434
import io.modelcontextprotocol.client.McpSyncClient;
35+
import io.modelcontextprotocol.client.transport.AsyncHttpRequestCustomizer;
36+
import io.modelcontextprotocol.client.transport.SyncHttpRequestCustomizer;
2537
import io.modelcontextprotocol.spec.McpSchema.ListToolsResult;
38+
import reactor.core.publisher.Mono;
2639

2740
@Timeout(15)
2841
public class SseHttpClientTransportAutoConfigurationIT {
@@ -79,8 +92,69 @@ void streamableHttpTest() {
7992
assertThat(toolsResult.tools()).hasSize(8);
8093

8194
logger.info("tools = {}", toolsResult);
82-
8395
});
8496
}
8597

98+
@Test
99+
void usesSyncRequestCustomizer() {
100+
this.contextRunner
101+
.withConfiguration(UserConfigurations.of(SyncRequestCustomizerConfiguration.class,
102+
AsyncRequestCustomizerConfiguration.class))
103+
.run(context -> {
104+
List<McpSyncClient> mcpClients = (List<McpSyncClient>) context.getBean("mcpSyncClients");
105+
106+
assertThat(mcpClients).isNotNull();
107+
assertThat(mcpClients).hasSize(1);
108+
109+
McpSyncClient mcpClient = mcpClients.get(0);
110+
111+
mcpClient.ping();
112+
113+
verify(context.getBean(SyncHttpRequestCustomizer.class), atLeastOnce()).customize(any(), any(), any(),
114+
any());
115+
verifyNoInteractions(context.getBean(AsyncHttpRequestCustomizer.class));
116+
});
117+
}
118+
119+
@Test
120+
void usesAsyncRequestCustomizer() {
121+
this.contextRunner.withConfiguration(UserConfigurations.of(AsyncRequestCustomizerConfiguration.class))
122+
.run(context -> {
123+
List<McpSyncClient> mcpClients = (List<McpSyncClient>) context.getBean("mcpSyncClients");
124+
125+
assertThat(mcpClients).isNotNull();
126+
assertThat(mcpClients).hasSize(1);
127+
128+
McpSyncClient mcpClient = mcpClients.get(0);
129+
130+
mcpClient.ping();
131+
132+
verify(context.getBean(AsyncHttpRequestCustomizer.class), atLeastOnce()).customize(any(), any(), any(),
133+
any());
134+
});
135+
}
136+
137+
@Configuration
138+
static class SyncRequestCustomizerConfiguration {
139+
140+
@Bean
141+
SyncHttpRequestCustomizer syncHttpRequestCustomizer() {
142+
return mock(SyncHttpRequestCustomizer.class);
143+
}
144+
145+
}
146+
147+
@Configuration
148+
static class AsyncRequestCustomizerConfiguration {
149+
150+
@Bean
151+
AsyncHttpRequestCustomizer asyncHttpRequestCustomizer() {
152+
AsyncHttpRequestCustomizer requestCustomizerMock = mock(AsyncHttpRequestCustomizer.class);
153+
when(requestCustomizerMock.customize(any(), any(), any(), any()))
154+
.thenAnswer(invocation -> Mono.just(invocation.getArguments()[0]));
155+
return requestCustomizerMock;
156+
}
157+
158+
}
159+
86160
}

‎auto-configurations/mcp/spring-ai-autoconfigure-mcp-client-httpclient/src/test/java/org/springframework/ai/mcp/client/autoconfigure/StreamableHttpHttpClientTransportAutoConfigurationIT.java‎

Lines changed: 76 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
/*
2-
* Copyright 2024-2024 the original author or authors.
2+
* Copyright 2024-2025 the original author or authors.
33
*/
44

55
package org.springframework.ai.mcp.client.autoconfigure;
66

77
import static org.assertj.core.api.Assertions.assertThat;
8+
import static org.mockito.ArgumentMatchers.any;
9+
import static org.mockito.Mockito.atLeastOnce;
10+
import static org.mockito.Mockito.mock;
11+
import static org.mockito.Mockito.verify;
12+
import static org.mockito.Mockito.verifyNoInteractions;
13+
import static org.mockito.Mockito.when;
814

915
import java.util.List;
1016

@@ -17,12 +23,19 @@
1723
import org.springframework.ai.mcp.client.common.autoconfigure.McpClientAutoConfiguration;
1824
import org.springframework.ai.mcp.client.httpclient.autoconfigure.StreamableHttpHttpClientTransportAutoConfiguration;
1925
import org.springframework.boot.autoconfigure.AutoConfigurations;
26+
import org.springframework.boot.context.annotation.UserConfigurations;
2027
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
28+
import org.springframework.context.annotation.Bean;
29+
import org.springframework.context.annotation.Configuration;
30+
2131
import org.testcontainers.containers.GenericContainer;
2232
import org.testcontainers.containers.wait.strategy.Wait;
2333

2434
import io.modelcontextprotocol.client.McpSyncClient;
35+
import io.modelcontextprotocol.client.transport.AsyncHttpRequestCustomizer;
36+
import io.modelcontextprotocol.client.transport.SyncHttpRequestCustomizer;
2537
import io.modelcontextprotocol.spec.McpSchema.ListToolsResult;
38+
import reactor.core.publisher.Mono;
2639

2740
@Timeout(15)
2841
public class StreamableHttpHttpClientTransportAutoConfigurationIT {
@@ -80,8 +93,69 @@ void streamableHttpTest() {
8093
assertThat(toolsResult.tools()).hasSize(8);
8194

8295
logger.info("tools = {}", toolsResult);
83-
8496
});
8597
}
8698

99+
@Test
100+
void usesSyncRequestCustomizer() {
101+
this.contextRunner
102+
.withConfiguration(UserConfigurations.of(SyncRequestCustomizerConfiguration.class,
103+
AsyncRequestCustomizerConfiguration.class))
104+
.run(context -> {
105+
List<McpSyncClient> mcpClients = (List<McpSyncClient>) context.getBean("mcpSyncClients");
106+
107+
assertThat(mcpClients).isNotNull();
108+
assertThat(mcpClients).hasSize(1);
109+
110+
McpSyncClient mcpClient = mcpClients.get(0);
111+
112+
mcpClient.ping();
113+
114+
verify(context.getBean(SyncHttpRequestCustomizer.class), atLeastOnce()).customize(any(), any(), any(),
115+
any());
116+
verifyNoInteractions(context.getBean(AsyncHttpRequestCustomizer.class));
117+
});
118+
}
119+
120+
@Test
121+
void usesAsyncRequestCustomizer() {
122+
this.contextRunner.withConfiguration(UserConfigurations.of(AsyncRequestCustomizerConfiguration.class))
123+
.run(context -> {
124+
List<McpSyncClient> mcpClients = (List<McpSyncClient>) context.getBean("mcpSyncClients");
125+
126+
assertThat(mcpClients).isNotNull();
127+
assertThat(mcpClients).hasSize(1);
128+
129+
McpSyncClient mcpClient = mcpClients.get(0);
130+
131+
mcpClient.ping();
132+
133+
verify(context.getBean(AsyncHttpRequestCustomizer.class), atLeastOnce()).customize(any(), any(), any(),
134+
any());
135+
});
136+
}
137+
138+
@Configuration
139+
static class SyncRequestCustomizerConfiguration {
140+
141+
@Bean
142+
SyncHttpRequestCustomizer syncHttpRequestCustomizer() {
143+
return mock(SyncHttpRequestCustomizer.class);
144+
}
145+
146+
}
147+
148+
@Configuration
149+
static class AsyncRequestCustomizerConfiguration {
150+
151+
@Bean
152+
AsyncHttpRequestCustomizer asyncHttpRequestCustomizer() {
153+
AsyncHttpRequestCustomizer requestCustomizerMock = mock(AsyncHttpRequestCustomizer.class);
154+
when(requestCustomizerMock.customize(any(), any(), any(), any()))
155+
.thenAnswer(invocation -> Mono.just(invocation.getArguments()[0]));
156+
return requestCustomizerMock;
157+
}
158+
159+
}
160+
87161
}

0 commit comments

Comments
 (0)