diff --git a/model-context-protocol/filesystem/.mvn/wrapper/maven-wrapper.jar b/model-context-protocol/filesystem/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..c1dd12f Binary files /dev/null and b/model-context-protocol/filesystem/.mvn/wrapper/maven-wrapper.jar differ diff --git a/model-context-protocol/filesystem/.mvn/wrapper/maven-wrapper.properties b/model-context-protocol/filesystem/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..b7cb93e --- /dev/null +++ b/model-context-protocol/filesystem/.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/filesystem/README.md b/model-context-protocol/filesystem/README.md new file mode 100644 index 0000000..0617847 --- /dev/null +++ b/model-context-protocol/filesystem/README.md @@ -0,0 +1,160 @@ +# Spring AI Model Context Protocol Demo Application + +A demo application showcasing the integration of Spring AI with File syste using the Model Context Protocol (MCP). +This application enables natural language interactions with predefiend folders in your local files system. + +It starts and connects to [Filesystem MCP-Server](https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem) with provided accsss to your `model-context-protocol/filesystem/target` folder + +## Features + +- Natural language querying and updateing files on your local file system +- Predefined question mode for automated database analysis +- Seamless integration with OpenAI's language models +- Built on Spring AI and Model Context Protocol + +## Prerequisites + +- Java 17 or higher +- Maven 3.6+ +- npx package manager +- Git +- OpenAI API key + +## Installation + +1. Install npx (Node Package eXecute): + first make sure to install [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) + and then run: + ```bash + npm install -g npx + ``` + +2. Clone the repository: + ```bash + git clone https://github.com/spring-projects/spring-ai-examples.git + cd model-context-protocol/filesystem + ``` + +3. Set up your OpenAI API key: + ```bash + export OPENAI_API_KEY='your-api-key-here' + ``` + +4. Build the demo: + ```bash + ./mvnw clean install + ``` + +## Create a sample text file to explore + +Create a sample `spring-ai-mcp-overview.txt` file under your `filesystem/target` directory manually or use the `create-text-file.sh` script + + +## Running the Application + +### Predefined Questions +Runs through a set of preset questions: +```bash +./mvnw spring-boot:run +``` + +## Architecture Overview + +Spring AI's integration with MCP follows a simple chain of components: + +1. **MCP Client** provides the base communication layer with your filesystem +2. **Function Callbacks** expose filesystem operations as AI-callable functions +3. **Chat Client** connects these functions to the AI model + +The bean definitions are described below, starting with the `ChatClient` + +### Chat Client + +```java +@Bean +@Profile("!chat") +public CommandLineRunner predefinedQuestions(ChatClient.Builder chatClientBuilder, + List functionCallbacks, + ConfigurableApplicationContext context) { + return args -> { + var chatClient = chatClientBuilder.defaultFunctions(functionCallbacks) + .build(); + // Run Predefined Questions + }; +} +``` + +The chat client setup is remarkably simple - it just needs the function callbacks that were automatically created from the MCP tools. Spring's dependency injection handles all the wiring, making the integration seamless. + +Now let's look at the other bean definitions in detail... + +### Function Callbacks + +The application registers MCP tools with Spring AI using function callbacks: + +```java +@Bean +public List functionCallbacks(McpSyncClient mcpClient) { + return mcpClient.listTools(null) + .tools() + .stream() + .map(tool -> new McpFunctionCallback(mcpClient, tool)) + .toList(); +} +``` + +#### Purpose + +This bean is responsible for: +1. Discovering available MCP tools from the client +2. Converting each tool into a Spring AI function callback +3. Making these callbacks available for use with the ChatClient + + +#### How It Works + +1. `mcpClient.listTools(null)` queries the MCP server for all available tools + - The `null` parameter represents a pagination cursor + - When null, returns the first page of results + - A cursor string can be provided to get results after that position +2. `.tools()` extracts the tool list from the response +3. Each tool is transformed into a `McpFunctionCallback` using `.map()` +4. These callbacks are collected into an array using `.toList()` + +#### Usage + +The registered callbacks enable the ChatClient to: +- Access MCP tools during conversations +- Handle function calls requested by the AI model +- Execute tools against the MCP server (e.g., filesystem) + + +### MCP Client + +The application uses a synchronous MCP client to communicate with the Filesystem MCP Server running locally: + +```java +@Bean(destroyMethod = "close") +public McpSyncClient mcpClient() { + var stdioParams = ServerParameters.builder("npx") + .args("-y", "@modelcontextprotocol/server-filesystem", getDbPath()) + .build(); + + var mcpClient = McpClient.sync(new StdioServerTransport(stdioParams), + Duration.ofSeconds(10), new ObjectMapper()); + + var init = mcpClient.initialize(); + System.out.println("MCP Initialized: " + init); + + return mcpClient; +} +``` + +This configuration: +1. Creates a stdio-based transport layer that communicates with the `npx` MCP server +2. Specifies the location of folders to be used by the filesystem server. +3. Sets a 10-second timeout for operations +4. Uses Jackson for JSON serialization +5. Initializes the connection to the MCP server + +The `destroyMethod = "close"` annotation ensures proper cleanup when the application shuts down. diff --git a/model-context-protocol/filesystem/create-text-file.sh b/model-context-protocol/filesystem/create-text-file.sh new file mode 100755 index 0000000..9214d46 --- /dev/null +++ b/model-context-protocol/filesystem/create-text-file.sh @@ -0,0 +1,37 @@ +#!/bin/bash + +# Get the directory where the script is located +SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) + +# Define the file path in the script's directory +FILE_PATH="$SCRIPT_DIR/target/spring-ai-mcp-overview.txt" + +echo "Creating a text file in $FILE_PATH..." + +# Create the file +cat << 'EOF' > "$FILE_PATH" + +Model Context Protocol (MCP) Java SDK + +A Java implementation of the Model Context Protocol specification, providing both synchronous and +asynchronous clients for MCP server interactions. + +Overview: This SDK implements the Model Context Protocol, enabling seamless integration with AI models and tools through +a standardized interface. It supports both synchronous and asynchronous communication patterns, making it suitable for +various use cases and integration scenarios. + +Features + + Synchronous and Asynchronous client implementations + Standard MCP operations support: + Tool discovery and execution + Resource management and templates + Prompt handling and management + Resource subscription system + Server initialization and ping + Stdio-based server transport + Reactive programming support using Project Reactor + +EOF + +echo "The file has been created in $FILE_PATH." diff --git a/model-context-protocol/filesystem/mvnw b/model-context-protocol/filesystem/mvnw new file mode 100755 index 0000000..eb65ff2 --- /dev/null +++ b/model-context-protocol/filesystem/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/filesystem/mvnw.cmd b/model-context-protocol/filesystem/mvnw.cmd new file mode 100755 index 0000000..4f5150a --- /dev/null +++ b/model-context-protocol/filesystem/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/filesystem/pom.xml b/model-context-protocol/filesystem/pom.xml new file mode 100644 index 0000000..62389f9 --- /dev/null +++ b/model-context-protocol/filesystem/pom.xml @@ -0,0 +1,80 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.3.6 + + + com.example + ai-mcp-fileserver + 0.0.1-SNAPSHOT + Spring AI - Model Context Protocol - Fileserver + Simple AI Application using MCP client to chat with FileServer + + 17 + + + + + + org.springframework.ai + spring-ai-bom + 1.0.0-M4 + pom + import + + + + + + + org.springframework.boot + spring-boot-starter + + + + org.springframework.ai + spring-ai-openai-spring-boot-starter + + + + org.springframework.experimental + spring-ai-mcp-spring + 0.1.0 + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + + + spring-milestones + Spring Milestones + https://repo.spring.io/libs-milestone-local + + false + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + false + + + + + + diff --git a/model-context-protocol/filesystem/src/main/java/org/springframework/ai/mcp/samples/filesystem/Application.java b/model-context-protocol/filesystem/src/main/java/org/springframework/ai/mcp/samples/filesystem/Application.java new file mode 100644 index 0000000..07940b6 --- /dev/null +++ b/model-context-protocol/filesystem/src/main/java/org/springframework/ai/mcp/samples/filesystem/Application.java @@ -0,0 +1,90 @@ +package org.springframework.ai.mcp.samples.filesystem; + +import java.nio.file.Paths; +import java.time.Duration; +import java.util.List; + +import com.fasterxml.jackson.databind.ObjectMapper; + +import org.springframework.ai.chat.client.ChatClient; +import org.springframework.ai.mcp.client.McpClient; +import org.springframework.ai.mcp.client.McpSyncClient; +import org.springframework.ai.mcp.client.stdio.ServerParameters; +import org.springframework.ai.mcp.client.stdio.StdioServerTransport; +import org.springframework.ai.mcp.spring.McpFunctionCallback; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.ConfigurableApplicationContext; +import org.springframework.context.annotation.Bean; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + + @Bean + public CommandLineRunner predefinedQuestions(ChatClient.Builder chatClientBuilder, + List functionCallbacks, ConfigurableApplicationContext context) { + + return args -> { + var chatClient = chatClientBuilder + .defaultFunctions(functionCallbacks.toArray(new McpFunctionCallback[0])) + .build(); + + System.out.println("Running predefined questions with AI model responses:\n"); + + // Question 1 + String question1 = "Can you explain the content of the spring-ai-mcp-overview.txt file?"; + System.out.println("QUESTION: " + question1); + System.out.println("ASSISTANT: " + chatClient.prompt(question1).call().content()); + + // Question 2 + String question2 = "Pleses summarize the content of the spring-ai-mcp-overview.txt file and store it a new summary.md as Markdown format?"; + System.out.println("\nQUESTION: " + question2); + System.out.println("ASSISTANT: " + + chatClient.prompt(question2).call().content()); + + context.close(); + + }; + } + + @Bean + public List functionCallbacks(McpSyncClient mcpClient) { + + var callbacks = mcpClient.listTools(null) + .tools() + .stream() + .map(tool -> new McpFunctionCallback(mcpClient, tool)) + .toList(); + return callbacks; + } + + @Bean(destroyMethod = "close") + public McpSyncClient mcpClient() { + + // based on + // https://github.com/modelcontextprotocol/servers/tree/main/src/filesystem + var stdioParams = ServerParameters.builder("npx") + .args("-y", "@modelcontextprotocol/server-filesystem", getDbPath()) + .build(); + + var mcpClient = McpClient.sync(new StdioServerTransport(stdioParams), + Duration.ofSeconds(10), new ObjectMapper()); + + var init = mcpClient.initialize(); + + System.out.println("MCP Initialized: " + init); + + return mcpClient; + + } + + private static String getDbPath() { + return Paths.get(System.getProperty("user.dir"), "target").toString(); + } + +} \ No newline at end of file diff --git a/model-context-protocol/filesystem/src/main/resources/application.properties b/model-context-protocol/filesystem/src/main/resources/application.properties new file mode 100644 index 0000000..863de4f --- /dev/null +++ b/model-context-protocol/filesystem/src/main/resources/application.properties @@ -0,0 +1,4 @@ +spring.application.name=mcp +spring.main.web-application-type=none + +spring.ai.openai.api-key=${OPENAI_API_KEY} \ No newline at end of file