feat(mcp): Add integration tests and improve documentation

- Add test dependencies and comprehensive integration tests for McpClientAutoConfiguration
- Reorganize code by moving properties and configurer classes into dedicated packages
- Add root change notification property to common properties
- Add extensive documentation for MCP client/server starters and common utilities
- Improve code documentation with detailed Javadoc comments
- Update navigation to include new MCP documentation sections

Signed-off-by: Christian Tzolov <[email protected]>

Author: tzolov

auto-configurations/spring-ai-mcp-client/pom.xml

@@ -50,6 +50,25 @@
 			<optional>true</optional>
 		</dependency> -->
 
+		<!-- Test dependencies -->
+		<dependency>
+			<groupId>org.springframework.ai</groupId>
+			<artifactId>spring-ai-test</artifactId>
+			<version>${project.parent.version}</version>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.mockito</groupId>
+			<artifactId>mockito-core</artifactId>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 
 </project>

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/McpClientAutoConfiguration.java

@@ -24,6 +24,9 @@
 import io.modelcontextprotocol.client.McpSyncClient;
 import io.modelcontextprotocol.spec.McpSchema;
 
+import org.springframework.ai.autoconfigure.mcp.client.configurer.McpAsyncClientConfigurer;
+import org.springframework.ai.autoconfigure.mcp.client.configurer.McpSyncClientConfigurer;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpClientCommonProperties;
 import org.springframework.ai.mcp.McpToolUtils;
 import org.springframework.ai.mcp.customizer.McpAsyncClientCustomizer;
 import org.springframework.ai.mcp.customizer.McpSyncClientCustomizer;
@@ -220,9 +223,7 @@ public ClosebleMcpSyncClients makeSyncClientsClosable(List<McpSyncClient> client
 	@ConditionalOnProperty(prefix = McpClientCommonProperties.CONFIG_PREFIX, name = "type", havingValue = "SYNC",
 			matchIfMissing = true)
 	McpSyncClientConfigurer mcpSyncClientConfigurer(ObjectProvider<McpSyncClientCustomizer> customizerProvider) {
-		McpSyncClientConfigurer configurer = new McpSyncClientConfigurer();
-		configurer.setCustomizers(customizerProvider.orderedStream().toList());
-		return configurer;
+		return new McpSyncClientConfigurer(customizerProvider.orderedStream().toList());
 	}
 
 	// Async client configuration
@@ -286,9 +287,7 @@ public ClosebleMcpAsyncClients makeAsynClientsClosable(List<McpAsyncClient> clie
 	@ConditionalOnMissingBean
 	@ConditionalOnProperty(prefix = McpClientCommonProperties.CONFIG_PREFIX, name = "type", havingValue = "ASYNC")
 	McpAsyncClientConfigurer mcpAsyncClientConfigurer(ObjectProvider<McpAsyncClientCustomizer> customizerProvider) {
-		McpAsyncClientConfigurer configurer = new McpAsyncClientConfigurer();
-		configurer.setCustomizers(customizerProvider.orderedStream().toList());
-		return configurer;
+		return new McpAsyncClientConfigurer(customizerProvider.orderedStream().toList());
 	}
 
 }

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/NamedClientMcpTransport.java

@@ -18,7 +18,9 @@
 import io.modelcontextprotocol.spec.ClientMcpTransport;
 
 /**
- * A named MCP client transport.
+ * A named MCP client transport. Usually created by the transport auto-configurations, but
+ * you can also create them manually. Expose the list castom NamedClientMcpTransport
+ * as @Bean.
  *
  * @param name the name of the transport. Usually the name of the server connection.
  * @param transport the MCP client transport.

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

@@ -26,7 +26,9 @@
 import io.modelcontextprotocol.client.transport.HttpClientSseClientTransport;
 import io.modelcontextprotocol.spec.McpSchema;
 
-import org.springframework.ai.autoconfigure.mcp.client.McpSseClientProperties.SseParameters;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpClientCommonProperties;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpSseClientProperties;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpSseClientProperties.SseParameters;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/SseWebFluxTransportAutoConfiguration.java

@@ -23,7 +23,9 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.modelcontextprotocol.client.transport.WebFluxSseClientTransport;
 
-import org.springframework.ai.autoconfigure.mcp.client.McpSseClientProperties.SseParameters;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpClientCommonProperties;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpSseClientProperties;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpSseClientProperties.SseParameters;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/StdioTransportAutoConfiguration.java

@@ -20,15 +20,14 @@
 import java.util.List;
 import java.util.Map;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import io.modelcontextprotocol.client.McpSyncClient;
 import io.modelcontextprotocol.client.transport.ServerParameters;
 import io.modelcontextprotocol.client.transport.StdioClientTransport;
 import io.modelcontextprotocol.spec.McpSchema;
 
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpClientCommonProperties;
+import org.springframework.ai.autoconfigure.mcp.client.properties.McpStdioClientProperties;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/McpAsyncClientConfigurer.java renamed to auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/configurer/McpAsyncClientConfigurer.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.ai.autoconfigure.mcp.client;
+package org.springframework.ai.autoconfigure.mcp.client.configurer;
 
 import java.util.List;
 
@@ -26,7 +26,7 @@ public class McpAsyncClientConfigurer {
 
 	private List<McpAsyncClientCustomizer> customizers;
 
-	void setCustomizers(List<McpAsyncClientCustomizer> customizers) {
+	public McpAsyncClientConfigurer(List<McpAsyncClientCustomizer> customizers) {
 		this.customizers = customizers;
 	}
 

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/McpSyncClientConfigurer.java renamed to auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/configurer/McpSyncClientConfigurer.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.ai.autoconfigure.mcp.client;
+package org.springframework.ai.autoconfigure.mcp.client.configurer;
 
 import java.util.List;
 
@@ -41,11 +41,7 @@ public class McpSyncClientConfigurer {
 
 	private List<McpSyncClientCustomizer> customizers;
 
-	/**
-	 * Sets the list of customizers to be applied to MCP sync clients.
-	 * @param customizers the list of customizers to apply
-	 */
-	void setCustomizers(List<McpSyncClientCustomizer> customizers) {
+	public McpSyncClientConfigurer(List<McpSyncClientCustomizer> customizers) {
 		this.customizers = customizers;
 	}
 

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/McpClientCommonProperties.java renamed to auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/properties/McpClientCommonProperties.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package org.springframework.ai.autoconfigure.mcp.client;
+package org.springframework.ai.autoconfigure.mcp.client.properties;
 
 import java.time.Duration;
 
@@ -93,6 +93,14 @@ public enum ClientType {
 
 	}
 
+	/**
+	 * Flag to enable/disable root change notifications.
+	 * <p>
+	 * When enabled, the client will be notified of changes to the root configuration.
+	 * Defaults to true.
+	 */
+	private boolean rootChangeNotification = true;
+
 	public boolean isEnabled() {
 		return this.enabled;
 	}
@@ -141,4 +149,12 @@ public void setType(ClientType type) {
 		this.type = type;
 	}
 
+	public boolean isRootChangeNotification() {
+		return this.rootChangeNotification;
+	}
+
+	public void setRootChangeNotification(boolean rootChangeNotification) {
+		this.rootChangeNotification = rootChangeNotification;
+	}
+
 }

auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/McpSseClientProperties.java renamed to auto-configurations/spring-ai-mcp-client/src/main/java/org/springframework/ai/autoconfigure/mcp/client/properties/McpSseClientProperties.java

@@ -13,7 +13,7 @@
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
-package org.springframework.ai.autoconfigure.mcp.client;
+package org.springframework.ai.autoconfigure.mcp.client.properties;
 
 import java.util.HashMap;
 import java.util.Map;