From ba07215c48170239b4e30bc3cb15763f46645632 Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Mon, 13 Jan 2025 09:11:17 +0100 Subject: [PATCH] Add MCP Servlet SSE demo --- .../.mvn/wrapper/maven-wrapper.properties | 19 ++ .../mcp-servlet-server/README.md | 222 +++++++++++++++ .../mcp-servlet-server/mvnw | 259 ++++++++++++++++++ .../mcp-servlet-server/mvnw.cmd | 149 ++++++++++ .../mcp-servlet-server/pom.xml | 92 +++++++ .../mcp/sample/webmvc/client/ClientStdio.java | 39 +++ .../sample/webmvc/client/HttpClientSse.java | 31 +++ .../sample/webmvc/client/SampleClient.java | 83 ++++++ .../sample/webmvc/server/McpServerConfig.java | 215 +++++++++++++++ .../server/McpServletServerApplication.java | 13 + .../mcp/sample/webmvc/server/OpenLibrary.java | 74 +++++ .../src/main/resources/application.properties | 8 + pom.xml | 1 + 13 files changed, 1205 insertions(+) create mode 100644 model-context-protocol/mcp-servlet-server/.mvn/wrapper/maven-wrapper.properties create mode 100644 model-context-protocol/mcp-servlet-server/README.md create mode 100755 model-context-protocol/mcp-servlet-server/mvnw create mode 100644 model-context-protocol/mcp-servlet-server/mvnw.cmd create mode 100644 model-context-protocol/mcp-servlet-server/pom.xml create mode 100644 model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/ClientStdio.java create mode 100644 model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/HttpClientSse.java create mode 100644 model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/SampleClient.java create mode 100644 model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServerConfig.java create mode 100644 model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServletServerApplication.java create mode 100644 model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/OpenLibrary.java create mode 100644 model-context-protocol/mcp-servlet-server/src/main/resources/application.properties diff --git a/model-context-protocol/mcp-servlet-server/.mvn/wrapper/maven-wrapper.properties b/model-context-protocol/mcp-servlet-server/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..d58dfb7 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,19 @@ +# 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. +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.9/apache-maven-3.9.9-bin.zip diff --git a/model-context-protocol/mcp-servlet-server/README.md b/model-context-protocol/mcp-servlet-server/README.md new file mode 100644 index 0000000..746f037 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/README.md @@ -0,0 +1,222 @@ +# Spring AI MCP Servlet SSE Server Sample Project + +This sample project demonstrates the usage of the Spring AI Model Context Protocol (MCP) implementation with HttpServletSseServerTransport. It showcases how to create and use MCP servers with Servlet-based SSE transport and various capabilities. + +## Overview + +The sample provides: +- Two transport mode implementations: + - HttpServletSseServerTransport for SSE (Server-Sent Events) + - StdioServerTransport for standard I/O +- Server capabilities: + - Tools support with list changes notifications + - Resources support with list changes notifications (no subscribe support) + - Prompts support with list changes notifications +- Sample implementations: + - Two MCP tools: Weather and Calculator + - One MCP resource: System Information + - One MCP prompt: Greeting + +## Building the Project + +```bash +./mvnw clean package +``` + +## Running the Server + +The server can be started in two transport modes, controlled by the `transport.mode` property: + +### Stdio Mode (Default) + +```bash +java -Dtransport.mode=stdio -jar target/mcp-servlet-server-0.0.1-SNAPSHOT.jar +``` + +The Stdio mode server is automatically started by the client - no explicit server startup is needed. +But you have to build the server jar first: `./mvnw clean install -DskipTests`. + +In Stdio mode the server must not emit any messages/logs to the console (e.g. standard out) but the JSON messages produced by the server. + +### SSE Mode with HttpServletSseServerTransport +```bash +java -Dtransport.mode=sse -jar target/mcp-servlet-server-0.0.1-SNAPSHOT.jar +``` + +The HttpServletSseServerTransport provides two endpoints: +- SSE endpoint at `/sse` - For server-to-client events +- Message endpoint at `/mcp/message` - For client-to-server messages + +## Sample Clients + +The project includes example clients for both transport modes: + +### Stdio Client (ClientStdio.java) +```java +var stdioParams = ServerParameters.builder("java") + .args("-Dtransport.mode=stdio", "-jar", + "target/mcp-servlet-server-0.0.1-SNAPSHOT.jar") + .build(); + +var transport = new StdioClientTransport(stdioParams); +var client = McpClient.using(transport).sync(); +``` + +### SSE Client (HttpClientSse.java) +```java +var transport = new HttpClientSseClientTransport("http://localhost:8080"); +var client = McpClient.using(transport).sync(); +``` + +## Available Tools + +### Weather Tool +- Name: `weather` +- Description: Weather forecast tool by location +- Parameters: + - `city`: String - The city to get weather for +- Example: +```java +CallToolResult response = client.callTool( + new CallToolRequest("weather", Map.of("city", "Sofia")) +); +``` + +### Calculator Tool +- Name: `calculator` +- Description: Performs basic arithmetic operations +- Parameters (JSON Schema): + ```json + { + "operation": { + "type": "string", + "enum": ["add", "subtract", "multiply", "divide"], + "description": "The arithmetic operation to perform" + }, + "a": { + "type": "number", + "description": "First operand" + }, + "b": { + "type": "number", + "description": "Second operand" + } + } + ``` +- Example: +```java +CallToolResult response = client.callTool( + new CallToolRequest("calculator", + Map.of("operation", "multiply", "a", 2.0, "b", 3.0)) +); +``` + +## Available Resources + +### System Information Resource +- URI: `system://info` +- Description: Provides basic system information including Java version, OS, etc. +- MIME Type: application/json +- Returns: JSON object containing: javaVersion, osName, osVersion, osArch, processors, timestamp + +## Available Prompts + +### Greeting Prompt +- Name: `greeting` +- Description: A friendly greeting prompt +- Parameters: + - `name`: String (required) - The name to greet +- Returns: A personalized greeting message from an assistant + +## Client Usage Example + +```java +// Initialize client +client.initialize(); + +// Test connection +client.ping(); + +// List available tools +ListToolsResult tools = client.listTools(); +System.out.println("Available tools: " + tools); + +// Call weather tool +CallToolResult weather = client.callTool( + new CallToolRequest("weather", Map.of("city", "Sofia")) +); +System.out.println("Weather: " + weather); + +// Access system info resource +ReadResourceResult sysInfo = client.readResource( + new ReadResourceRequest("system://info") +); +System.out.println("System Info: " + sysInfo); + +// Use greeting prompt +GetPromptResult greeting = client.getPrompt( + new GetPromptRequest("greeting", Map.of("name", "John")) +); +System.out.println("Greeting: " + greeting); + +// Close client +client.closeGracefully(); +``` + +## Server Configuration Example + +```java +@Configuration +@EnableWebMvc +public class McpServerConfig implements WebMvcConfigurer { + + @Bean + @ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse") + public HttpServletSseServerTransport webSseServerTransport() { + return new HttpServletSseServerTransport(new ObjectMapper(), "/mcp/message"); + } + + @Bean + @ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse") + public ServletRegistrationBean customServletBean(HttpServletSseServerTransport servlet) { + return new ServletRegistrationBean(servlet, "/sse", "/mcp/message"); + } + + @Bean + public McpAsyncServer mcpServer(ServerMcpTransport transport) { + // Configure server capabilities + var capabilities = McpSchema.ServerCapabilities.builder() + .resources(false, true) // Resource support with list changes notifications + .tools(true) // Tool support with list changes notifications + .prompts(true) // Prompt support with list changes notifications + .build(); + + // Create and configure the server + return McpServer.using(transport) + .serverInfo("MCP Demo Server", "1.0.0") + .capabilities(capabilities) + // Add your tools, resources, and prompts here + .async(); + } +} +``` + +## Configuration + +The application can be configured through `application.properties`: + +- `transport.mode`: Transport mode to use (stdio/sse) +- `server.port`: Server port for SSE mode (default: 8080) +- Various logging configurations are available for debugging + +## Implementation Details + +The sample demonstrates: +- Using HttpServletSseServerTransport for SSE-based communication +- Creating an MCP server with custom tools, resources, and prompts +- Configuring different transport modes +- Implementing tool handlers with JSON schema validation +- Resource implementations with dynamic content generation +- Prompt implementations with parameter handling +- Error handling and response formatting +- Synchronous client usage patterns diff --git a/model-context-protocol/mcp-servlet-server/mvnw b/model-context-protocol/mcp-servlet-server/mvnw new file mode 100755 index 0000000..19529dd --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/mvnw @@ -0,0 +1,259 @@ +#!/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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.2 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + 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" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/model-context-protocol/mcp-servlet-server/mvnw.cmd b/model-context-protocol/mcp-servlet-server/mvnw.cmd new file mode 100644 index 0000000..b150b91 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/mvnw.cmd @@ -0,0 +1,149 @@ +<# : batch portion +@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 Apache Maven Wrapper startup batch script, version 3.3.2 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' +$MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/model-context-protocol/mcp-servlet-server/pom.xml b/model-context-protocol/mcp-servlet-server/pom.xml new file mode 100644 index 0000000..7451caf --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/pom.xml @@ -0,0 +1,92 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.3.6 + + + + com.example + mcp-servlet-server + 0.0.1-SNAPSHOT + + Spring AI MCP Servlet Server Sample + Sample application demonstrating MCP Servlet server usage + + + 0.5.0-SNAPSHOT + + + + + org.springframework.experimental + spring-ai-mcp + ${spring-ai-mcp.version} + + + + org.springframework.boot + spring-boot-starter-web + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + repackage + + + + + + io.spring.javaformat + spring-javaformat-maven-plugin + 0.0.43 + + + validate + true + + validate + + + + + + + + + + spring-milestones + Spring Milestones + https://repo.spring.io/libs-milestone-local + + false + + + + spring-snapshots + Spring Snapshots + https://repo.spring.io/snapshot + + false + + + + + \ No newline at end of file diff --git a/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/ClientStdio.java b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/ClientStdio.java new file mode 100644 index 0000000..4885940 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/ClientStdio.java @@ -0,0 +1,39 @@ +/* +* Copyright 2024 - 2024 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.sample.webmvc.client; + +import org.springframework.ai.mcp.client.transport.ServerParameters; +import org.springframework.ai.mcp.client.transport.StdioClientTransport; + +/** + * With stdio transport, the MCP server is automatically started by the client. But you + * have to build the server jar first: 
./mvnw clean install -DskipTests
+ */ +public class ClientStdio { + + public static void main(String[] args) { + + var stdioParams = ServerParameters.builder("java") + .args("-Dtransport.mode=stdio", "-jar", + "model-context-protocol/mcp-servlet-server/target/mcp-servlet-server-0.0.1-SNAPSHOT.jar") + .build(); + + var transport = new StdioClientTransport(stdioParams); + + new SampleClient(transport).run(); + } + +} diff --git a/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/HttpClientSse.java b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/HttpClientSse.java new file mode 100644 index 0000000..27f7964 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/HttpClientSse.java @@ -0,0 +1,31 @@ +/* +* Copyright 2024 - 2024 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.sample.webmvc.client; + +import org.springframework.ai.mcp.client.transport.HttpClientSseClientTransport; + +/** + * @author Christian Tzolov + */ +public class HttpClientSse { + + public static void main(String[] args) { + var transport = new HttpClientSseClientTransport("http://localhost:8080"); + + new SampleClient(transport).run(); + } + +} diff --git a/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/SampleClient.java b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/SampleClient.java new file mode 100644 index 0000000..3d536d2 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/client/SampleClient.java @@ -0,0 +1,83 @@ +/* +* Copyright 2024 - 2024 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.sample.webmvc.client; + +import java.util.Map; + +import org.springframework.ai.mcp.client.McpClient; +import org.springframework.ai.mcp.spec.ClientMcpTransport; +import org.springframework.ai.mcp.spec.McpSchema.CallToolRequest; +import org.springframework.ai.mcp.spec.McpSchema.CallToolResult; +import org.springframework.ai.mcp.spec.McpSchema.GetPromptRequest; +import org.springframework.ai.mcp.spec.McpSchema.ListPromptsResult; +import org.springframework.ai.mcp.spec.McpSchema.ListToolsResult; +import org.springframework.ai.mcp.spec.McpSchema.ReadResourceRequest; + +/** + * @author Christian Tzolov + */ + +public class SampleClient { + + private final ClientMcpTransport transport; + + public SampleClient(ClientMcpTransport transport) { + this.transport = transport; + } + + public void run() { + + var client = McpClient.using(this.transport).sync(); + + client.initialize(); + + client.ping(); + + // List and demonstrate tools + ListToolsResult toolsList = client.listTools(); + System.out.println("Available Tools = " + toolsList); + + CallToolResult weatherResponse = client.callTool(new CallToolRequest("weather", Map.of("city", "Sofia"))); + System.out.println("Weather Response = " + weatherResponse); + + CallToolResult paymentStatus = client.callTool( + new CallToolRequest("paymentTransactionStatus", Map.of("transactionId", "006", "accountName", "John"))); + System.out.println("Payment Status Response = " + paymentStatus); + + CallToolResult parks = client.callTool(new CallToolRequest("getBooks", Map.of("title", "Spring Framework"))); + System.out.println("Books Response = " + parks); + + // List and demonstrate resources + var resourcesList = client.listResources(); + System.out.println("\nAvailable Resources = " + resourcesList); + + // Read the system info resource + var systemInfo = client.readResource(new ReadResourceRequest("system://info")); + System.out.println("System Info = " + systemInfo); + + // List and demonstrate prompts + ListPromptsResult promptsList = client.listPrompts(); + System.out.println("\nAvailable Prompts = " + promptsList); + + // Try the greeting prompt + var greetingResponse = client.getPrompt(new GetPromptRequest("greeting", Map.of("name", "Spring"))); + System.out.println("Greeting Response = " + greetingResponse); + + client.closeGracefully(); + + } + +} diff --git a/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServerConfig.java b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServerConfig.java new file mode 100644 index 0000000..5332945 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServerConfig.java @@ -0,0 +1,215 @@ +package org.springframework.ai.mcp.sample.webmvc.server; + +import java.util.List; +import java.util.Map; +import java.util.function.Function; + +import com.fasterxml.jackson.databind.ObjectMapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import org.springframework.ai.mcp.server.McpAsyncServer; +import org.springframework.ai.mcp.server.McpServer; +import org.springframework.ai.mcp.server.McpServer.PromptRegistration; +import org.springframework.ai.mcp.server.McpServer.ResourceRegistration; +import org.springframework.ai.mcp.server.McpServer.ToolRegistration; +import org.springframework.ai.mcp.server.transport.HttpServletSseServerTransport; +import org.springframework.ai.mcp.server.transport.StdioServerTransport; +import org.springframework.ai.mcp.spec.McpSchema; +import org.springframework.ai.mcp.spec.McpSchema.CallToolResult; +import org.springframework.ai.mcp.spec.McpSchema.GetPromptResult; +import org.springframework.ai.mcp.spec.McpSchema.LoggingMessageNotification; +import org.springframework.ai.mcp.spec.McpSchema.PromptMessage; +import org.springframework.ai.mcp.spec.McpSchema.Role; +import org.springframework.ai.mcp.spec.McpSchema.TextContent; +import org.springframework.ai.mcp.spec.ServerMcpTransport; +import org.springframework.ai.mcp.spring.ToolHelper; +import org.springframework.ai.model.function.FunctionCallback; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.web.servlet.ServletRegistrationBean; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.web.client.RestClient; +import org.springframework.web.servlet.config.annotation.EnableWebMvc; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Configuration +@EnableWebMvc +public class McpServerConfig implements WebMvcConfigurer { + + private static final Logger logger = LoggerFactory.getLogger(McpServerConfig.class); + + @Bean + @ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse") + public HttpServletSseServerTransport webMvcSseServerTransport() { + return new HttpServletSseServerTransport(new ObjectMapper(), "/mcp/message"); + } + + @Bean + @ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse") + public ServletRegistrationBean customServletBean(HttpServletSseServerTransport servlet) { + return new ServletRegistrationBean(servlet); + } + + // STDIO transport + @Bean + @ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "stdio") + public StdioServerTransport stdioServerTransport() { + return new StdioServerTransport(); + } + + @Bean + public McpAsyncServer mcpServer(ServerMcpTransport transport, OpenLibrary openLibrary) { // @formatter:off + + // Configure server capabilities with resource support + var capabilities = McpSchema.ServerCapabilities.builder() + .resources(false, true) // No subscribe support, but list changes notifications + .tools(true) // Tool support with list changes notifications + .prompts(true) // Prompt support with list changes notifications + .logging() // Logging support + .build(); + + // Create the server with both tool and resource capabilities + var server = McpServer.using(transport) + .serverInfo("MCP Demo Server", "1.0.0") + .capabilities(capabilities) + .resources(systemInfoResourceRegistration()) + .prompts(greetingPromptRegistration()) + .tools( + ToolHelper.toToolRegistration( + FunctionCallback.builder() + .method("paymentTransactionStatus",String.class, String.class) + .description("Get transaction payment status") + .targetClass(McpServerConfig.class) + .build()), + ToolHelper.toToolRegistration( + FunctionCallback.builder() + .function("toUpperCase", new Function() { + @Override + public String apply(String s) { + return s.toUpperCase(); + } + }) + .description("To upper case") + .inputType(String.class) + .build())) + .tools(openLibraryToolRegistrations(openLibrary)) + .async(); + + server.addTool(weatherToolRegistration(server)); + return server; // @formatter:on + } // @formatter:on + + public static List openLibraryToolRegistrations(OpenLibrary openLibrary) { + + var books = FunctionCallback.builder() + .method("getBooks", String.class) + .description("Get list of Books by title") + .targetObject(openLibrary) + .build(); + + var bookTitlesByAuthor = FunctionCallback.builder() + .method("getBookTitlesByAuthor", String.class) + .description("Get book titles by author") + .targetObject(openLibrary) + .build(); + + return ToolHelper.toToolRegistration(books, bookTitlesByAuthor); + } + + private static ResourceRegistration systemInfoResourceRegistration() { + + // Create a resource registration for system information + var systemInfoResource = new McpSchema.Resource( // @formatter:off + "system://info", + "System Information", + "Provides basic system information including Java version, OS, etc.", + "application/json", null + ); + + var resourceRegistration = new ResourceRegistration(systemInfoResource, (request) -> { + try { + var systemInfo = Map.of( + "javaVersion", System.getProperty("java.version"), + "osName", System.getProperty("os.name"), + "osVersion", System.getProperty("os.version"), + "osArch", System.getProperty("os.arch"), + "processors", Runtime.getRuntime().availableProcessors(), + "timestamp", System.currentTimeMillis()); + + String jsonContent = new ObjectMapper().writeValueAsString(systemInfo); + + return new McpSchema.ReadResourceResult( + List.of(new McpSchema.TextResourceContents(request.uri(), "application/json", jsonContent))); + } + catch (Exception e) { + throw new RuntimeException("Failed to generate system info", e); + } + }); // @formatter:on + + return resourceRegistration; + } + + private static PromptRegistration greetingPromptRegistration() { + + var prompt = new McpSchema.Prompt("greeting", "A friendly greeting prompt", + List.of(new McpSchema.PromptArgument("name", "The name to greet", true))); + + return new PromptRegistration(prompt, getPromptRequest -> { + + String nameArgument = (String) getPromptRequest.arguments().get("name"); + if (nameArgument == null) { + nameArgument = "friend"; + } + + var userMessage = new PromptMessage(Role.USER, + new TextContent("Hello " + nameArgument + "! How can I assist you today?")); + + return new GetPromptResult("A personalized greeting message", List.of(userMessage)); + }); + } + + private static ToolRegistration weatherToolRegistration(McpAsyncServer server) { + String emptyJsonSchema = """ + { + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": {"city" : "string"} + } + """; + return new ToolRegistration(new McpSchema.Tool("weather", "Weather forecast tool by location", emptyJsonSchema), + (arguments) -> { + String city = (String) arguments.get("city"); + + // Create the result + var result = new CallToolResult( + List.of(new TextContent("Weather forecast for " + city + " is sunny")), false); + + // Send the logging notification and ignore its completion + server + .loggingNotification(LoggingMessageNotification.builder() + .data("This is a log message from the weather tool") + .build()) + .subscribe(null, error -> { + // Log any errors but don't fail the operation + logger.error("Failed to send logging notification", error); + }); + + return result; + }); + } + + public static String paymentTransactionStatus(String transactionId, String accountName) { + return "The status for " + transactionId + ", by " + accountName + " is PENDING"; + } + + public Function toUpperCase() { + return String::toUpperCase; + } + + @Bean + public OpenLibrary openLibrary() { + return new OpenLibrary(RestClient.builder()); + } + +} diff --git a/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServletServerApplication.java b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServletServerApplication.java new file mode 100644 index 0000000..56eada5 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/McpServletServerApplication.java @@ -0,0 +1,13 @@ +package org.springframework.ai.mcp.sample.webmvc.server; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class McpServletServerApplication { + + public static void main(String[] args) { + SpringApplication.run(McpServletServerApplication.class, args); + } + +} diff --git a/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/OpenLibrary.java b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/OpenLibrary.java new file mode 100644 index 0000000..3dfe835 --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/java/org/springframework/ai/mcp/sample/webmvc/server/OpenLibrary.java @@ -0,0 +1,74 @@ +/* +* Copyright 2024 - 2024 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.sample.webmvc.server; + +import java.util.List; +import java.util.Map; + +import org.springframework.web.client.RestClient; + +/** + * @author Christian Tzolov + */ + +public class OpenLibrary { + + private RestClient restClient; + + public OpenLibrary(RestClient.Builder restClientBuilder) { + this.restClient = restClientBuilder.baseUrl("https://openlibrary.org").build(); + } + + public record Books(Integer numFound, Integer start, Boolean numFoundExact, List> docs) { + } + + public record Book(List isbn, String title, List authorName) { + } + + public List getBooks(String title) { + Books books = restClient.get() + .uri(uriBuilder -> uriBuilder.path("/search.json").queryParam("q", title).build()) + .retrieve() + .body(Books.class); + if (books == null) { + return List.of(); + } + return books.docs.stream() + .map(doc -> new Book((List) doc.get("isbn"), (String) doc.get("title"), + (List) doc.get("author_name"))) + .toList(); + } + + public List getBookTitlesByAuthor(String authorName) { + var books = restClient.get() + .uri(uriBuilder -> uriBuilder.path("/search/authors.json").queryParam("q", authorName).build()) + .retrieve() + .body(Books.class); + if (books == null) { + return List.of(); + } + return books.docs.stream().map(doc -> (String) doc.get("top_work")).toList(); + } + + public static void main(String[] args) { + OpenLibrary openLibrary = new OpenLibrary(RestClient.builder()); + List books = openLibrary.getBooks("Spring Framework"); + System.out.println(books); + List booksByAuthor = openLibrary.getBookTitlesByAuthor("Craig Walls"); + System.out.println(booksByAuthor); + } + +} diff --git a/model-context-protocol/mcp-servlet-server/src/main/resources/application.properties b/model-context-protocol/mcp-servlet-server/src/main/resources/application.properties new file mode 100644 index 0000000..4bc4fbf --- /dev/null +++ b/model-context-protocol/mcp-servlet-server/src/main/resources/application.properties @@ -0,0 +1,8 @@ +spring.main.web-application-type=SERVLET + +# NOTE: You must disable the banner and the console logging +# to allow the STDIO transport to work !!! +spring.main.banner-mode=off +logging.pattern.console= + +transport.mode=sse \ No newline at end of file diff --git a/pom.xml b/pom.xml index 36c30f2..b7cb414 100644 --- a/pom.xml +++ b/pom.xml @@ -27,6 +27,7 @@ model-context-protocol/brave model-context-protocol/mcp-webmvc-server model-context-protocol/mcp-webflux-server + model-context-protocol/mcp-servlet-server