diff --git a/model-context-protocol/sqlite/.mvn/wrapper/maven-wrapper.jar b/model-context-protocol/sqlite/chatbot/.mvn/wrapper/maven-wrapper.jar similarity index 100% rename from model-context-protocol/sqlite/.mvn/wrapper/maven-wrapper.jar rename to model-context-protocol/sqlite/chatbot/.mvn/wrapper/maven-wrapper.jar diff --git a/model-context-protocol/sqlite/.mvn/wrapper/maven-wrapper.properties b/model-context-protocol/sqlite/chatbot/.mvn/wrapper/maven-wrapper.properties similarity index 100% rename from model-context-protocol/sqlite/.mvn/wrapper/maven-wrapper.properties rename to model-context-protocol/sqlite/chatbot/.mvn/wrapper/maven-wrapper.properties diff --git a/model-context-protocol/sqlite/chatbot/README.md b/model-context-protocol/sqlite/chatbot/README.md new file mode 100644 index 0000000..c55df5f --- /dev/null +++ b/model-context-protocol/sqlite/chatbot/README.md @@ -0,0 +1,158 @@ +# Spring AI Model Context Protocol - SQLite Chatbot + +A demo application showcasing the integration of Spring AI with SQLite databases using the Model Context Protocol (MCP). This application enables natural language interactions with your SQLite database through a command-line interface. + +It uses the [SQLite MCP-Server](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite) to enable running SQL queries, analyzing business data, and automatically generating business insight memos. + +The demo starts a simple chatbot where your can ask qustions about the data stored in the database. + +For example: +> Can you connect to my SQLite database and tell me what products are available, and their prices? + +or perform some data aggreagation on the fly: + +> What's the average price of all products in the database? + +run annalysis + +> Can you analyze the price distribution and suggest any pricing optimizations? + +or even create an new table: + +> Could you help me design and create a new table for storing customer orders? + +## Features + +- Natural language querying of SQLite databases +- Interactive chat mode for dynamic database interactions +- 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+ +- uvx package manager +- Git +- OpenAI API key +- SQLite (optional, for database modifications) + +## Installation + +1. Install uvx (Universal Package Manager): + ```bash + # Follow installation instructions at: + https://docs.astral.sh/uv/getting-started/installation/ + ``` + +2. Clone the repository: + ```bash + git clone https://github.com/spring-projects/spring-ai-examples.git + cd model-context-protocol/sqlite + ``` + +3. Set up your OpenAI API key: + ```bash + export OPENAI_API_KEY='your-api-key-here' + ``` + +## Sample SQLite database + +SQLite database files are portable across operating systems. This repository contains a sample database file named `test.db`. + +It has a `PRODUCTS` table and was created using the script `create-database.sh` + +## Running the Application + +### Interactive Chat +Enables real-time conversation with your database: + +```bash +./mvnw spring-boot:run -Dspring-boot.run.profiles=chat +``` + +## Architecture Overview + +### MCP Client Configuration + +The application uses a synchronous MCP client to communicate with the SQLite database: + +```java +@Bean(destroyMethod = "close") +public McpSyncClient mcpClient() { + + var stdioParams = ServerParameters.builder("uvx") + .args("mcp-server-sqlite", "--db-path", 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 `uvx` MCP server +2. Specifies SQLite as the backend database and its location +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. + +### 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 `.toArray(McpFunctionCallback[]::new)` + +#### 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., SQLite database) + + +## Documentation references + +You can find out more about this sample application following the this quickstart link to a specific verison in github. + +Unfortunately, on December 10th 2024, the quickstart was changed from SQLite to be a weather retrieval example. + +However, here is the [link](https://github.com/modelcontextprotocol/docs/blob/1024e03f83aa0b8badde9b50dfee4d2e4e7f9446/quickstart.mdx) to the docs before the change if you want to read up on some details. + +For example, you may want to create other tables and install SQLite \ No newline at end of file diff --git a/model-context-protocol/sqlite/create-database.sh b/model-context-protocol/sqlite/chatbot/create-database.sh similarity index 100% rename from model-context-protocol/sqlite/create-database.sh rename to model-context-protocol/sqlite/chatbot/create-database.sh diff --git a/model-context-protocol/sqlite/mvnw b/model-context-protocol/sqlite/chatbot/mvnw similarity index 100% rename from model-context-protocol/sqlite/mvnw rename to model-context-protocol/sqlite/chatbot/mvnw diff --git a/model-context-protocol/sqlite/mvnw.cmd b/model-context-protocol/sqlite/chatbot/mvnw.cmd similarity index 100% rename from model-context-protocol/sqlite/mvnw.cmd rename to model-context-protocol/sqlite/chatbot/mvnw.cmd diff --git a/model-context-protocol/sqlite/chatbot/pom.xml b/model-context-protocol/sqlite/chatbot/pom.xml new file mode 100644 index 0000000..8b14722 --- /dev/null +++ b/model-context-protocol/sqlite/chatbot/pom.xml @@ -0,0 +1,80 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.3.6 + + + com.example + ai-mdp-sqlite-chatbot + 0.0.1-SNAPSHOT + Spring AI - Model Context Protocol - SQLite + Simple AI Application using MCP client to chat with SQLite + + 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/sqlite/chatbot/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java b/model-context-protocol/sqlite/chatbot/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java new file mode 100644 index 0000000..0d02f5d --- /dev/null +++ b/model-context-protocol/sqlite/chatbot/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java @@ -0,0 +1,100 @@ +package org.springframework.ai.mcp.samples.sqlite; + +import java.nio.file.Paths; +import java.time.Duration; +import java.util.List; +import java.util.Scanner; + +import com.fasterxml.jackson.databind.ObjectMapper; + +import org.springframework.ai.chat.client.ChatClient; +import org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor; +import org.springframework.ai.chat.memory.InMemoryChatMemory; +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 interactiveChat(ChatClient.Builder chatClientBuilder, + List functionCallbacks, + ConfigurableApplicationContext context) { + return args -> { + + var chatClient = chatClientBuilder + .defaultFunctions(functionCallbacks.toArray(new McpFunctionCallback[0])) + .defaultAdvisors(new MessageChatMemoryAdvisor(new InMemoryChatMemory())) + .build(); + + var scanner = new Scanner(System.in); + System.out.println("\nStarting interactive chat session. Type 'exit' to quit."); + + try { + while (true) { + System.out.print("\nUSER: "); + String input = scanner.nextLine(); + + if (input.equalsIgnoreCase("exit")) { + System.out.println("Ending chat session."); + break; + } + + System.out.print("ASSISTANT: "); + System.out.println(chatClient.prompt(input).call().content()); + } + } finally { + scanner.close(); + 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() { + + var stdioParams = ServerParameters.builder("uvx") + .args("mcp-server-sqlite", "--db-path", + 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"), "test.db").toString(); + } + +} \ No newline at end of file diff --git a/model-context-protocol/sqlite/src/main/resources/application.properties b/model-context-protocol/sqlite/chatbot/src/main/resources/application.properties similarity index 100% rename from model-context-protocol/sqlite/src/main/resources/application.properties rename to model-context-protocol/sqlite/chatbot/src/main/resources/application.properties diff --git a/model-context-protocol/sqlite/test.db b/model-context-protocol/sqlite/chatbot/test.db similarity index 100% rename from model-context-protocol/sqlite/test.db rename to model-context-protocol/sqlite/chatbot/test.db diff --git a/model-context-protocol/sqlite/simple/.mvn/wrapper/maven-wrapper.jar b/model-context-protocol/sqlite/simple/.mvn/wrapper/maven-wrapper.jar new file mode 100644 index 0000000..c1dd12f Binary files /dev/null and b/model-context-protocol/sqlite/simple/.mvn/wrapper/maven-wrapper.jar differ diff --git a/model-context-protocol/sqlite/simple/.mvn/wrapper/maven-wrapper.properties b/model-context-protocol/sqlite/simple/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..b7cb93e --- /dev/null +++ b/model-context-protocol/sqlite/simple/.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/sqlite/README.md b/model-context-protocol/sqlite/simple/README.md similarity index 91% rename from model-context-protocol/sqlite/README.md rename to model-context-protocol/sqlite/simple/README.md index 993d9ad..e44a725 100644 --- a/model-context-protocol/sqlite/README.md +++ b/model-context-protocol/sqlite/simple/README.md @@ -1,7 +1,9 @@ -# Spring AI Model Context Protocol Demo Application +# Spring AI Model Context Protocol Demo Application for SQLite A demo application showcasing the integration of Spring AI with SQLite databases using the Model Context Protocol (MCP). This application enables natural language interactions with your SQLite database through a command-line interface. +It uses the [SQLite MCP-Server](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite) to enable running SQL queries, analyzing business data, and automatically generating business insight memos. + ## Features @@ -47,18 +49,12 @@ It has a `PRODUCTS` table and was created using the script `create-database.sh` ## Running the Application -### Mode 1: Predefined Questions +### Predefined Questions Runs through a set of preset database queries: ```bash ./mvnw spring-boot:run ``` -### Mode 2: Interactive Chat -Enables real-time conversation with your database: -```bash -./mvnw spring-boot:run -Dspring-boot.run.profiles=chat -``` - ## Architecture Overview ### MCP Client Configuration @@ -97,12 +93,12 @@ The application registers MCP tools with Spring AI using function callbacks: ```java @Bean -public McpFunctionCallback[] functionCallbacks(McpSyncClient mcpClient) { +public List functionCallbacks(McpSyncClient mcpClient) { return mcpClient.listTools(null) .tools() .stream() .map(tool -> new McpFunctionCallback(mcpClient, tool)) - .toArray(McpFunctionCallback[]::new); + .toList(); } ``` diff --git a/model-context-protocol/sqlite/simple/create-database.sh b/model-context-protocol/sqlite/simple/create-database.sh new file mode 100755 index 0000000..151787c --- /dev/null +++ b/model-context-protocol/sqlite/simple/create-database.sh @@ -0,0 +1,40 @@ +#!/bin/bash + +# Get the directory where the script is located +SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) + +# Define the database file path in the script's directory +DB_PATH="$SCRIPT_DIR/test.db" + +# Execute the SQL commands using sqlite3 +sqlite3 "$DB_PATH" < \(.*\)$'` + 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/sqlite/simple/mvnw.cmd b/model-context-protocol/sqlite/simple/mvnw.cmd new file mode 100755 index 0000000..4f5150a --- /dev/null +++ b/model-context-protocol/sqlite/simple/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/sqlite/pom.xml b/model-context-protocol/sqlite/simple/pom.xml similarity index 100% rename from model-context-protocol/sqlite/pom.xml rename to model-context-protocol/sqlite/simple/pom.xml diff --git a/model-context-protocol/sqlite/simple/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java b/model-context-protocol/sqlite/simple/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java new file mode 100644 index 0000000..bcb273d --- /dev/null +++ b/model-context-protocol/sqlite/simple/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java @@ -0,0 +1,103 @@ +package org.springframework.ai.mcp.samples.sqlite; + +import java.nio.file.Paths; +import java.time.Duration; +import java.util.List; +import java.util.Scanner; + +import com.fasterxml.jackson.databind.ObjectMapper; + +import org.springframework.ai.chat.client.ChatClient; +import org.springframework.ai.chat.client.advisor.MessageChatMemoryAdvisor; +import org.springframework.ai.chat.memory.InMemoryChatMemory; +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; +import org.springframework.context.annotation.Profile; + +@SpringBootApplication +public class Application { + + public static void main(String[] args) { + SpringApplication.run(Application.class, args); + } + + @Bean + @Profile("!chat") + 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 connect to my SQLite database and tell me what products are available, and their prices?"; + System.out.println("QUESTION: " + question1); + System.out.println("ASSISTANT: " + chatClient.prompt(question1).call().content()); + + // Question 2 + String question2 = "What's the average price of all products in the database?"; + System.out.println("\nQUESTION: " + question2); + System.out.println("ASSISTANT: " + chatClient.prompt(question2).call().content()); + + // Question 3 + String question3 = "Can you analyze the price distribution and suggest any pricing optimizations?"; + System.out.println("\nQUESTION: " + question3); + System.out.println("ASSISTANT: " + chatClient.prompt(question3).call().content()); + + // Question 4 + String question4 = "Could you help me design and create a new table for storing customer orders?"; + System.out.println("\nQUESTION: " + question4); + System.out.println("ASSISTANT: " + chatClient.prompt(question4).call().content()); + + System.out.println("\nPredefined questions completed. Exiting application."); + 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() { + + var stdioParams = ServerParameters.builder("uvx") + .args("mcp-server-sqlite", "--db-path", + 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"), "test.db").toString(); + } + +} \ No newline at end of file diff --git a/model-context-protocol/sqlite/simple/src/main/resources/application.properties b/model-context-protocol/sqlite/simple/src/main/resources/application.properties new file mode 100644 index 0000000..863de4f --- /dev/null +++ b/model-context-protocol/sqlite/simple/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 diff --git a/model-context-protocol/sqlite/simple/test.db b/model-context-protocol/sqlite/simple/test.db new file mode 100644 index 0000000..3ad6032 Binary files /dev/null and b/model-context-protocol/sqlite/simple/test.db differ diff --git a/model-context-protocol/sqlite/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java b/model-context-protocol/sqlite/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java deleted file mode 100644 index 7b969f1..0000000 --- a/model-context-protocol/sqlite/src/main/java/org/springframework/ai/mcp/samples/sqlite/Application.java +++ /dev/null @@ -1,139 +0,0 @@ -package org.springframework.ai.mcp.samples.sqlite; - -import java.nio.file.Paths; -import java.time.Duration; -import java.util.List; -import java.util.Scanner; - -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; -import org.springframework.context.annotation.Profile; - -@SpringBootApplication -public class Application { - - public static void main(String[] args) { - SpringApplication.run(Application.class, args); - } - - - @Bean - @Profile("!chat") - public CommandLineRunner predefinedQuestions(ChatClient.Builder chatClientBuilder, - List functionCallbacks, - ConfigurableApplicationContext context) { - return args -> { - var chatClient = chatClientBuilder.defaultFunctions(functionCallbacks.toArray(new McpFunctionCallback[0])) - .build(); - runPredefinedQuestions(chatClient, context); - }; - } - - @Bean - @Profile("chat") - public CommandLineRunner interactiveChat(ChatClient.Builder chatClientBuilder, - List functionCallbacks, - ConfigurableApplicationContext context) { - return args -> { - var chatClient = chatClientBuilder.defaultFunctions(functionCallbacks.toArray(new McpFunctionCallback[0])) - .build(); - startInteractiveChat(chatClient, context); - }; - } - - private void startInteractiveChat(ChatClient chatClient, ConfigurableApplicationContext context) { - var scanner = new Scanner(System.in); - System.out.println("\nStarting interactive chat session. Type 'exit' to quit."); - - try { - while (true) { - System.out.print("\nUSER: "); - String input = scanner.nextLine(); - - if (input.equalsIgnoreCase("exit")) { - System.out.println("Ending chat session."); - break; - } - - System.out.print("ASSISTANT: "); - System.out.println(chatClient.prompt(input).call().content()); - } - } finally { - scanner.close(); - context.close(); - } - } - - private void runPredefinedQuestions(ChatClient chatClient, ConfigurableApplicationContext context) { - System.out.println("Running predefined questions with AI model responses:\n"); - - // Question 1 - String question1 = "Can you connect to my SQLite database and tell me what products are available, and their prices?"; - System.out.println("QUESTION: " + question1); - System.out.println("ASSISTANT: " + chatClient.prompt(question1).call().content()); - - // Question 2 - String question2 = "What's the average price of all products in the database?"; - System.out.println("\nQUESTION: " + question2); - System.out.println("ASSISTANT: " + chatClient.prompt(question2).call().content()); - - // Question 3 - String question3 = "Can you analyze the price distribution and suggest any pricing optimizations?"; - System.out.println("\nQUESTION: " + question3); - System.out.println("ASSISTANT: " + chatClient.prompt(question3).call().content()); - - // Question 4 - String question4 = "Could you help me design and create a new table for storing customer orders?"; - System.out.println("\nQUESTION: " + question4); - System.out.println("ASSISTANT: " + chatClient.prompt(question4).call().content()); - - System.out.println("\nPredefined questions completed. Exiting application."); - context.close(); - } - - @Bean - public McpFunctionCallback[] functionCallbacks(McpSyncClient mcpClient) { - - return mcpClient.listTools(null) - .tools() - .stream() - .map(tool -> new McpFunctionCallback(mcpClient, tool)) - .toArray(McpFunctionCallback[]::new); - } - - @Bean(destroyMethod = "close") - public McpSyncClient mcpClient() { - - var stdioParams = ServerParameters.builder("uvx") - .args("mcp-server-sqlite", "--db-path", - 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"), "test.db").toString(); - } - -} \ No newline at end of file diff --git a/pom.xml b/pom.xml index 60bd3c2..3f4e20f 100644 --- a/pom.xml +++ b/pom.xml @@ -21,6 +21,8 @@ kotlin/rag-with-kotlin misc/spring-ai-java-function-callback misc/openai-streaming-response + model-context-protocol/sqlite/simple + model-context-protocol/sqlite/chatbot diff --git a/test.db b/test.db new file mode 100644 index 0000000..997b9c5 Binary files /dev/null and b/test.db differ