diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/.mvn/wrapper/maven-wrapper.jar b/model-context-protocol/client-starter/starter-streamable-http-client/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..c1dd12f Binary files /dev/null and b/model-context-protocol/client-starter/starter-streamable-http-client/.mvn/wrapper/maven-wrapper.jar differ diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/.mvn/wrapper/maven-wrapper.properties b/model-context-protocol/client-starter/starter-streamable-http-client/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..b7cb93e --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,2 @@ +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip +wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/README.md b/model-context-protocol/client-starter/starter-streamable-http-client/README.md new file mode 100644 index 0000000..ab4c01a --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/README.md @@ -0,0 +1,116 @@ +# Spring AI - MCP Starter Streamable HTTP Client + +This project demonstrates how to use the Spring AI MCP (Model Context Protocol) Client Boot Starter with streamable HTTP transport in a Spring Boot application. It showcases how to connect to MCP servers via streamable HTTP connections and integrate them with Spring AI's tool execution framework. + +Follow the [MCP Client Boot Starter](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) reference documentation. + +## Overview + +The project uses Spring Boot 3.4.5 and Spring AI 1.1.0-SNAPSHOT to create a command-line application that demonstrates MCP server integration. The application: +- Connects to MCP servers using streamable HTTP transport +- Integrates with Spring AI's chat capabilities +- Demonstrates tool execution through MCP servers +- Takes a user-defined question via the `-Dai.user.input` command-line property, which is mapped to a Spring `@Value` annotation in the code + +For example, running the application with `-Dai.user.input="Does Spring AI support MCP?"` will inject this question into the application through Spring's property injection, and the application will use it to query the MCP server. + +## Prerequisites + +- Java 17 or later +- Maven 3.6+ +- OpenAI API key (Get one at https://platform.openai.com/api-keys) +- A running MCP server accessible via HTTP (e.g., Chrome MCP server) + +## Dependencies + +The project uses the following main dependencies: + +```xml + + + org.springframework.ai + spring-ai-starter-mcp-client + + + org.springframework.ai + spring-ai-starter-model-openai + + +``` + +## Configuration + +### Application Properties + +Check the [MCP Client configuration properties](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html#_configuration_properties) documentation. + +The application can be configured through `application.properties` or `application.yml`: + +#### Common Properties +```properties +# Application Configuration +spring.application.name=mcp +spring.main.web-application-type=none + +# AI Provider Configuration +spring.ai.openai.api-key=${OPENAI_API_KEY} + +# Enable the MCP client tool-callback auto-configuration +spring.ai.mcp.client.toolcallback.enabled=true +``` + +#### Streamable HTTP Transport Properties + +Follow the [Streamable HTTP Configuration properties](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) documentation. + +Configure a separate, named configuration for each streamable HTTP server you connect to: + +```properties +spring.ai.mcp.client.streamable.connections.chrome.url=http://127.0.0.1:12306 +spring.ai.mcp.client.streamable.connections.chrome.endpoint=/mcp +``` + +Here, `chrome` is the name of your connection. The configuration specifies: +- `url`: The base URL of the MCP server +- `endpoint`: The specific endpoint path for MCP communication + + +## How It Works + +The application demonstrates a simple command-line interaction with an AI model using MCP tools: + +1. The application starts and configures MCP Clients using streamable HTTP transport connections +2. It builds a ChatClient with the configured MCP tools +3. Sends a predefined question (set via the `ai.user.input` property) to the AI model +4. Displays the AI's response +5. Automatically closes the application + +## Running the Application + +1. Set the required environment variables: + ```bash + export OPENAI_API_KEY=your-openai-api-key + ``` + +2. Build the application: + ```bash + ./mvnw clean install + ``` + +3. Run the application: + ```bash + # Run with the default question from application.properties + java -jar target/mcp-starter-streamable-http-client-0.0.1-SNAPSHOT.jar + + # Or specify a custom question + java -Dai.user.input='What tools are available?' -jar target/mcp-starter-streamable-http-client-0.0.1-SNAPSHOT.jar + ``` + +The application will execute the question, use the configured MCP tools to answer it, and display the AI assistant's response. + +## Additional Resources + +- [Spring AI Documentation](https://docs.spring.io/spring-ai/reference/) +- [MCP Client Boot Starter](https://docs.spring.io/spring-ai/reference/api/mcp/mcp-client-boot-starter-docs.html) +- [Model Context Protocol Specification](https://modelcontextprotocol.github.io/specification/) +- [Spring Boot Documentation](https://docs.spring.io/spring-boot/docs/current/reference/html/) diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/mvnw b/model-context-protocol/client-starter/starter-streamable-http-client/mvnw new file mode 100644 index 0000000..eb65ff2 --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/mvnw @@ -0,0 +1,305 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Maven2 Start Up Batch script +# +# Required ENV vars: +# ------------------ +# JAVA_HOME - location of a JDK home dir +# +# Optional ENV vars +# ----------------- +# M2_HOME - location of maven2's installed home dir +# MAVEN_OPTS - parameters passed to the Java VM when running Maven +# e.g. to debug Maven itself, use +# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +# MAVEN_SKIP_RC - flag to disable loading of mavenrc files +# ---------------------------------------------------------------------------- + +if [ -z "$MAVEN_SKIP_RC" ] ; then + + if [ -f /etc/mavenrc ] ; then + . /etc/mavenrc + fi + + if [ -f "$HOME/.mavenrc" ] ; then + . "$HOME/.mavenrc" + fi + +fi + +# OS specific support. $var _must_ be set to either true or false. +cygwin=false; +darwin=false; +mingw=false +case "`uname`" in + CYGWIN*) cygwin=true ;; + MINGW*) mingw=true;; + Darwin*) darwin=true + # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home + # See https://developer.apple.com/library/mac/qa/qa1170/_index.html + if [ -z "$JAVA_HOME" ]; then + if [ -x "/usr/libexec/java_home" ]; then + export JAVA_HOME="`/usr/libexec/java_home`" + else + export JAVA_HOME="/Library/Java/Home" + fi + fi + ;; +esac + +if [ -z "$JAVA_HOME" ] ; then + if [ -r /etc/gentoo-release ] ; then + JAVA_HOME=`java-config --jre-home` + fi +fi + +if [ -z "$M2_HOME" ] ; then + ## resolve links - $0 may be a link to maven's home + PRG="$0" + + # need this for relative symlinks + while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG="`dirname "$PRG"`/$link" + fi + done + + saveddir=`pwd` + + M2_HOME=`dirname "$PRG"`/.. + + # make it fully qualified + M2_HOME=`cd "$M2_HOME" && pwd` + + cd "$saveddir" + # echo Using m2 at $M2_HOME +fi + +# For Cygwin, ensure paths are in UNIX format before anything is touched +if $cygwin ; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --unix "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --unix "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --unix "$CLASSPATH"` +fi + +# For Mingw, ensure paths are in UNIX format before anything is touched +if $mingw ; then + [ -n "$M2_HOME" ] && + M2_HOME="`(cd "$M2_HOME"; pwd)`" + [ -n "$JAVA_HOME" ] && + JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" +fi + +if [ -z "$JAVA_HOME" ]; then + javaExecutable="`which javac`" + if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then + # readlink(1) is not available as standard on Solaris 10. + readLink=`which readlink` + if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then + if $darwin ; then + javaHome="`dirname \"$javaExecutable\"`" + javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" + else + javaExecutable="`readlink -f \"$javaExecutable\"`" + fi + javaHome="`dirname \"$javaExecutable\"`" + javaHome=`expr "$javaHome" : '\(.*\)/bin'` + JAVA_HOME="$javaHome" + export JAVA_HOME + fi + fi +fi + +if [ -z "$JAVACMD" ] ; then + if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + else + JAVACMD="`which java`" + fi +fi + +if [ ! -x "$JAVACMD" ] ; then + echo "Error: JAVA_HOME is not defined correctly." >&2 + echo " We cannot execute $JAVACMD" >&2 + exit 1 +fi + +if [ -z "$JAVA_HOME" ] ; then + echo "Warning: JAVA_HOME environment variable is not set." +fi + +CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher + +# traverses directory structure from process work directory to filesystem root +# first directory with .mvn subdirectory is considered project base directory +find_maven_basedir() { + + if [ -z "$1" ] + then + echo "Path not specified to find_maven_basedir" + return 1 + fi + + basedir="$1" + wdir="$1" + while [ "$wdir" != '/' ] ; do + if [ -d "$wdir"/.mvn ] ; then + basedir=$wdir + break + fi + # workaround for JBEAP-8937 (on Solaris 10/Sparc) + if [ -d "${wdir}" ]; then + wdir=`cd "$wdir/.."; pwd` + fi + # end of workaround + done + echo "${basedir}" +} + +# concatenates all lines of a file +concat_lines() { + if [ -f "$1" ]; then + echo "$(tr -s '\n' ' ' < "$1")" + fi +} + +BASE_DIR=`find_maven_basedir "$(pwd)"` +if [ -z "$BASE_DIR" ]; then + exit 1; +fi + +########################################################################################## +# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +# This allows using the maven wrapper in projects that prohibit checking in binary data. +########################################################################################## +if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found .mvn/wrapper/maven-wrapper.jar" + fi +else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." + fi + if [ "$MVNW_REPOURL" = true]; then + jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" + else + jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" + fi + while IFS="=" read key value; do + case "$key" in (wrapperUrl) jarUrl="$value"; break ;; + esac + done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" + if [ "$MVNW_VERBOSE" = true ]; then + echo "Downloading from: $jarUrl" + fi + wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" + if $cygwin; then + wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` + fi + + if command -v wget > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found wget ... using wget" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + wget "$jarUrl" -O "$wrapperJarPath" + else + wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" + fi + elif command -v curl > /dev/null; then + if [ "$MVNW_VERBOSE" = true ]; then + echo "Found curl ... using curl" + fi + if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then + curl -o "$wrapperJarPath" "$jarUrl" -f + else + curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f + fi + + else + if [ "$MVNW_VERBOSE" = true ]; then + echo "Falling back to using Java to download" + fi + javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" + # For Cygwin, switch paths to Windows format before running javac + if $cygwin; then + javaClass=`cygpath --path --windows "$javaClass"` + fi + if [ -e "$javaClass" ]; then + if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Compiling MavenWrapperDownloader.java ..." + fi + # Compiling the Java class + ("$JAVA_HOME/bin/javac" "$javaClass") + fi + if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then + # Running the downloader + if [ "$MVNW_VERBOSE" = true ]; then + echo " - Running MavenWrapperDownloader.java ..." + fi + ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") + fi + fi + fi +fi +########################################################################################## +# End of extension +########################################################################################## + +export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} +if [ "$MVNW_VERBOSE" = true ]; then + echo $MAVEN_PROJECTBASEDIR +fi +MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" + +# For Cygwin, switch paths to Windows format before running java +if $cygwin; then + [ -n "$M2_HOME" ] && + M2_HOME=`cygpath --path --windows "$M2_HOME"` + [ -n "$JAVA_HOME" ] && + JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` + [ -n "$CLASSPATH" ] && + CLASSPATH=`cygpath --path --windows "$CLASSPATH"` + [ -n "$MAVEN_PROJECTBASEDIR" ] && + MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` +fi + +WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +exec "$JAVACMD" \ + $MAVEN_OPTS \ + -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ + "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ + ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/mvnw.cmd b/model-context-protocol/client-starter/starter-streamable-http-client/mvnw.cmd new file mode 100644 index 0000000..4f5150a --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/mvnw.cmd @@ -0,0 +1,172 @@ +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Maven2 Start Up Batch script +@REM +@REM Required ENV vars: +@REM JAVA_HOME - location of a JDK home dir +@REM +@REM Optional ENV vars +@REM M2_HOME - location of maven2's installed home dir +@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands +@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a key stroke before ending +@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven +@REM e.g. to debug Maven itself, use +@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 +@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files +@REM ---------------------------------------------------------------------------- + +@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' +@echo off +@REM set title of command window +title %0 +@REM enable echoing my setting MAVEN_BATCH_ECHO to 'on' +@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% + +@REM set %HOME% to equivalent of $HOME +if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") + +@REM Execute a user defined script before this one +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre +@REM check for pre script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" +if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" +:skipRcPre + +@setlocal + +set ERROR_CODE=0 + +@REM To isolate internal variables from possible post scripts, we use another setlocal +@setlocal + +@REM ==== START VALIDATION ==== +if not "%JAVA_HOME%" == "" goto OkJHome + +echo. +echo Error: JAVA_HOME not found in your environment. >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +:OkJHome +if exist "%JAVA_HOME%\bin\java.exe" goto init + +echo. +echo Error: JAVA_HOME is set to an invalid directory. >&2 +echo JAVA_HOME = "%JAVA_HOME%" >&2 +echo Please set the JAVA_HOME variable in your environment to match the >&2 +echo location of your Java installation. >&2 +echo. +goto error + +@REM ==== END VALIDATION ==== + +:init + +@REM Find the project base dir, i.e. the directory that contains the folder ".mvn". +@REM Fallback to current working directory if not found. + +set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% +IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir + +set EXEC_DIR=%CD% +set WDIR=%EXEC_DIR% +:findBaseDir +IF EXIST "%WDIR%"\.mvn goto baseDirFound +cd .. +IF "%WDIR%"=="%CD%" goto baseDirNotFound +set WDIR=%CD% +goto findBaseDir + +:baseDirFound +set MAVEN_PROJECTBASEDIR=%WDIR% +cd "%EXEC_DIR%" +goto endDetectBaseDir + +:baseDirNotFound +set MAVEN_PROJECTBASEDIR=%EXEC_DIR% +cd "%EXEC_DIR%" + +:endDetectBaseDir + +IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig + +@setlocal EnableExtensions EnableDelayedExpansion +for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a +@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% + +:endReadAdditionalConfig + +SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" +set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" +set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain + +set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" + +FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( + IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B +) + +@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central +@REM This allows using the maven wrapper in projects that prohibit checking in binary data. +if exist %WRAPPER_JAR% ( + echo Found %WRAPPER_JAR% +) else ( + if not "%MVNW_REPOURL%" == "" ( + SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.2/maven-wrapper-0.5.2.jar" + ) + echo Couldn't find %WRAPPER_JAR%, downloading it ... + echo Downloading from: %DOWNLOAD_URL% + + powershell -Command "&{"^ + "$webclient = new-object System.Net.WebClient;"^ + "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ + "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ + "}"^ + "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ + "}" + echo Finished downloading %WRAPPER_JAR% +) +@REM End of extension + +%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* +if ERRORLEVEL 1 goto error +goto end + +:error +set ERROR_CODE=1 + +:end +@endlocal & set ERROR_CODE=%ERROR_CODE% + +if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost +@REM check for post script, once with legacy .bat ending and once with .cmd ending +if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" +if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" +:skipRcPost + +@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' +if "%MAVEN_BATCH_PAUSE%" == "on" pause + +if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% + +exit /B %ERROR_CODE% diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/pom.xml b/model-context-protocol/client-starter/starter-streamable-http-client/pom.xml new file mode 100644 index 0000000..817502f --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/pom.xml @@ -0,0 +1,103 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.4.5 + + + com.example + mcp-starter-streamable-http-client + 0.0.1-SNAPSHOT + Spring AI - MCP Starter Streamable HTTP Client + Spring AI - MCP Starter Streamable HTTP Client + + + 17 + 1.1.0-SNAPSHOT + + + + + + org.springframework.ai + spring-ai-bom + ${spring-ai.version} + pom + import + + + + + + + + org.springframework.ai + spring-ai-starter-mcp-client + + + mcp + io.modelcontextprotocol.sdk + + + + + + org.springframework.ai + spring-ai-starter-model-openai + + + io.modelcontextprotocol.sdk + mcp + 0.11.0-SNAPSHOT + + + + + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + + + Central Portal Snapshots + central-portal-snapshots + https://central.sonatype.com/repository/maven-snapshots/ + + false + + + true + + + + spring-milestones + Spring Milestones + https://repo.spring.io/milestone + + false + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + false + + + + + diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/Application.java b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/Application.java new file mode 100644 index 0000000..11ba463 --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/Application.java @@ -0,0 +1,69 @@ +/* + * Copyright 2025-2025 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.springframework.ai.mcp.samples.client; + +import com.fasterxml.jackson.databind.ObjectMapper; +import io.modelcontextprotocol.client.transport.HttpClientStreamableHttpTransport; +import org.springframework.ai.chat.client.ChatClient; +import org.springframework.ai.mcp.client.autoconfigure.NamedClientMcpTransport; +import org.springframework.ai.mcp.client.autoconfigure.properties.McpClientCommonProperties; +import org.springframework.ai.mcp.client.autoconfigure.properties.McpSseClientProperties; +import org.springframework.ai.tool.ToolCallbackProvider; +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.EnableAutoConfiguration; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Bean; + +import java.net.http.HttpClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +@SpringBootApplication + +@EnableConfigurationProperties({McpStreamableClientProperties.class, McpClientCommonProperties.class}) +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + + @Value("${ai.user.input}") + private String userInput; + + @Bean + public CommandLineRunner predefinedQuestions(ChatClient.Builder chatClientBuilder, ToolCallbackProvider tools, + ConfigurableApplicationContext context) { + + return args -> { + + var chatClient = chatClientBuilder + .defaultToolCallbacks(tools) + .build(); + + System.out.println("\n>>> QUESTION: " + userInput); + + System.out.println("\n>>> ASSISTANT: " + chatClient.prompt(userInput).call().content()); + + context.close(); + }; + } +} \ No newline at end of file diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/McpStreamableClientProperties.java b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/McpStreamableClientProperties.java new file mode 100644 index 0000000..d2bfe36 --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/McpStreamableClientProperties.java @@ -0,0 +1,78 @@ +/* + * Copyright 2025-2025 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.ai.mcp.samples.client; + +import org.springframework.ai.mcp.client.autoconfigure.properties.McpSseClientProperties; +import org.springframework.boot.context.properties.ConfigurationProperties; + +import java.util.HashMap; +import java.util.Map; + +/** + * Configuration properties for Streamable Http based MCP client connections. + * + *

+ * These properties allow configuration of multiple named streamable HTTP connections to MCP servers. + * Each connection is configured with a URL and endpoint for streamable HTTP communication. + * + *

+ * Example configuration: 

+ * spring.ai.mcp.client.streamable:
+ *   connections:
+ *     server1:
+ *       url: http://localhost:8080
+ *       endpoint: /mcp
+ *     server2:
+ *       url: http://otherserver:8081
+ *       endpoint: /mcp
+ *
+ * + * @author Dafu Wnag + * @since 1.0.0 + * @see + */ +@ConfigurationProperties(McpStreamableClientProperties.CONFIG_PREFIX) +public class McpStreamableClientProperties { + + public static final String CONFIG_PREFIX = "spring.ai.mcp.client.streamable"; + + /** + * Map of named streamable HTTP connection configurations. + *

+ * The key represents the connection name, and the value contains the streamable HTTP parameters + * for that connection. + */ + private final Map connections = new HashMap<>(); + + /** + * Returns the map of configured streamable HTTP connections. + * @return map of connection names to their streamable HTTP parameters + */ + public Map getConnections() { + return this.connections; + } + + /** + * Parameters for configuring a streamable HTTP connection to an MCP server. + * + * @param url the base URL for streamable HTTP communication with the MCP server + * @param endpoint the endpoint path for the MCP server + */ + public record StreamableParameters(String url, String endpoint) { + } + +} diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/StreamableHttpClientTransportAutoConfiguration.java b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/StreamableHttpClientTransportAutoConfiguration.java new file mode 100644 index 0000000..b917dc6 --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/java/org/springframework/ai/mcp/samples/client/StreamableHttpClientTransportAutoConfiguration.java @@ -0,0 +1,75 @@ +/* + * Copyright 2025-2025 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.ai.mcp.samples.client; + +import com.fasterxml.jackson.databind.ObjectMapper; +import io.modelcontextprotocol.client.McpSyncClient; +import io.modelcontextprotocol.client.transport.HttpClientSseClientTransport; +import io.modelcontextprotocol.client.transport.HttpClientStreamableHttpTransport; +import io.modelcontextprotocol.spec.McpSchema; +import org.springframework.ai.mcp.client.autoconfigure.NamedClientMcpTransport; +import org.springframework.ai.mcp.client.autoconfigure.SseWebFluxTransportAutoConfiguration; +import org.springframework.ai.mcp.client.autoconfigure.properties.McpClientCommonProperties; +import org.springframework.ai.mcp.client.autoconfigure.properties.McpSseClientProperties; +import org.springframework.ai.mcp.client.autoconfigure.properties.McpSseClientProperties.SseParameters; +import org.springframework.beans.factory.ObjectProvider; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.net.http.HttpClient; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + + + +@Configuration +@ConditionalOnProperty(prefix = McpClientCommonProperties.CONFIG_PREFIX, name = "enabled", havingValue = "true", + matchIfMissing = true) +public class StreamableHttpClientTransportAutoConfiguration { + + + @Bean("streamableTransport") + public List mcpHttpClientTransports(McpStreamableClientProperties sseProperties, + ObjectProvider objectMapperProvider) { + + ObjectMapper objectMapper = objectMapperProvider.getIfAvailable(ObjectMapper::new); + + List sseTransports = new ArrayList<>(); + + for (Map.Entry serverParameters : sseProperties.getConnections().entrySet()) { + + String baseUrl = serverParameters.getValue().url(); + String sseEndpoint = serverParameters.getValue() != null + ? serverParameters.getValue().endpoint() : "/message"; + var transport = HttpClientStreamableHttpTransport.builder(baseUrl) + .endpoint(sseEndpoint) + .clientBuilder(HttpClient.newBuilder()) + .objectMapper(objectMapper) + .build(); + sseTransports.add(new NamedClientMcpTransport(serverParameters.getKey(), transport)); + } + + return sseTransports; + } + +} diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/src/main/resources/application.properties b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/resources/application.properties new file mode 100644 index 0000000..50a6380 --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/resources/application.properties @@ -0,0 +1,18 @@ +spring.application.name=mcp +spring.main.web-application-type=none + +spring.ai.openai.api-key=${OPENAI_API_KEY} +#spring.ai.anthropic.api-key=${ANTHROPIC_API_KEY} + +# spring.ai.mcp.client.stdio.servers-configuration=classpath:/mcp-servers-config.json +#spring.ai.mcp.client.stdio.connections.brave-search.command=npx +#spring.ai.mcp.client.stdio.connections.brave-search.args=-y,@modelcontextprotocol/server-brave-search +# spring.ai.mcp.client.stdio.connections.brave-search.env.FOO=BAAR +spring.ai.mcp.client.streamable.connections.chrome.url=http://127.0.0.1:12306 +spring.ai.mcp.client.streamable.connections.chrome.endpoint=/mcp +logging.level.io.modelcontextprotocol.client=WARN +logging.level.io.modelcontextprotocol.spec=WARN + +ai.user.input=What tools are available? + +spring.ai.mcp.client.toolcallback.enabled=true \ No newline at end of file diff --git a/model-context-protocol/client-starter/starter-streamable-http-client/src/main/resources/mcp-servers-config.json b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/resources/mcp-servers-config.json new file mode 100644 index 0000000..80ef9c4 --- /dev/null +++ b/model-context-protocol/client-starter/starter-streamable-http-client/src/main/resources/mcp-servers-config.json @@ -0,0 +1,4 @@ +{ + "mcpServers": { + } +} \ No newline at end of file diff --git a/pom.xml b/pom.xml index 461a33d..7cc3b6d 100644 --- a/pom.xml +++ b/pom.xml @@ -32,6 +32,7 @@ model-context-protocol/brave-docker-agents-gateway model-context-protocol/client-starter/starter-default-client model-context-protocol/client-starter/starter-webflux-client + model-context-protocol/client-starter/starter-streamable-http-client model-context-protocol/filesystem model-context-protocol/weather/manual-webflux-server model-context-protocol/weather/starter-stdio-server