refactor: Split transport implementations into modules
Split the transport implementations into dedicated modules to improve modularity and reduce core dependencies. Added shared test module for common test utilities. Key changes: - Create mcp-transport/mcp-webflux-sse-transport module - Move SseClientTransport → WebFluxSseClientTransport - Move SseServerTransport → WebFluxSseServerTransport - Move related tests and utilities - Create mcp-transport/mcp-webmvc-sse-transport module - Add new WebMvcSseServerTransport implementation - Add corresponding tests and integration tests - Add framework-independent SSE client implementations to core module - Add FlowSseClient using java.net.http - Add HttpClientSseClientTransport using java.net.http - Keep StdioClientTransport/StdioServerTransport in core (no external deps) - Create mcp-test module for shared test infrastructure - Move abstract test base classes - Move shared test utilities and mocks - Update test dependencies The modular approach allows users to choose between: - Framework-specific implementations (WebFlux/WebMVC) - Pure Java implementations (java.net.http) - Basic implementations (STDIO) Add breaking changes readme: 0.5.0-BREAKING-CHANGES.md Resolves #54
This commit is contained in:
Christian Tzolov
parent
85c4fb8713
commit
611f3258d6
10 changed files with 5002 additions and 1588 deletions
257
samples/spring-ai-mcp-sample/README.md
Normal file
257
samples/spring-ai-mcp-sample/README.md
Normal file
|
|
@ -0,0 +1,257 @@
|
|||
# Spring AI MCP Sample Project
|
||||
|
||||
This sample project demonstrates the usage of the Spring AI Model Context Protocol (MCP) implementation. It showcases how to create and use MCP servers and clients with different transport modes and capabilities.
|
||||
|
||||
## Overview
|
||||
|
||||
The sample provides:
|
||||
- Two transport mode implementations: Stdio and SSE (Server-Sent Events)
|
||||
- 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/spring-ai-mcp-sample-0.5.0-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
|
||||
```bash
|
||||
java -Dtransport.mode=sse -jar target/spring-ai-mcp-sample-0.5.0-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
## 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/spring-ai-mcp-sample-0.5.0-SNAPSHOT.jar")
|
||||
.build();
|
||||
|
||||
var transport = new StdioClientTransport(stdioParams);
|
||||
var client = McpClient.using(transport).sync();
|
||||
```
|
||||
|
||||
### SSE Client (ClientSse.java)
|
||||
```java
|
||||
var transport = new SseClientTransport(WebClient.builder().baseUrl("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);
|
||||
|
||||
// Call calculator tool
|
||||
CallToolResult calc = client.callTool(
|
||||
new CallToolRequest("calculator",
|
||||
Map.of("operation", "multiply", "a", 2.0, "b", 3.0))
|
||||
);
|
||||
System.out.println("Calculation: " + calc);
|
||||
|
||||
// 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 Usage Example
|
||||
|
||||
```java
|
||||
@Configuration
|
||||
public class CustomMcpServerConfig {
|
||||
@Bean
|
||||
public McpAsyncServer mcpServer(McpTransport 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 custom tool
|
||||
var customTool = new ToolRegistration(
|
||||
new McpSchema.Tool("custom-tool", "Description", Map.of("param", "String")),
|
||||
(arguments) -> {
|
||||
String param = (String) arguments.get("param");
|
||||
return new CallToolResult(
|
||||
List.of(new TextContent("Result: " + param)),
|
||||
false
|
||||
);
|
||||
}
|
||||
);
|
||||
|
||||
// Create custom resource
|
||||
var customResource = new ResourceRegistration(
|
||||
new McpSchema.Resource(
|
||||
"custom://resource",
|
||||
"Custom Resource",
|
||||
"Description",
|
||||
"application/json",
|
||||
null
|
||||
),
|
||||
(request) -> new ReadResourceResult(
|
||||
List.of(new TextResourceContents(
|
||||
request.uri(),
|
||||
"application/json",
|
||||
"{\"data\": \"example\"}"
|
||||
))
|
||||
)
|
||||
);
|
||||
|
||||
// Create custom prompt
|
||||
var customPrompt = new PromptRegistration(
|
||||
new McpSchema.Prompt(
|
||||
"custom-prompt",
|
||||
"Description",
|
||||
List.of(new McpSchema.PromptArgument("input", "Description", true))
|
||||
),
|
||||
request -> {
|
||||
String input = (String) request.arguments().get("input");
|
||||
var message = new PromptMessage(
|
||||
Role.ASSISTANT,
|
||||
new TextContent("Response to: " + input)
|
||||
);
|
||||
return new GetPromptResult("Result", List.of(message));
|
||||
}
|
||||
);
|
||||
|
||||
// Create and configure the server
|
||||
return McpServer.using(transport)
|
||||
.info("Custom MCP Server", "1.0.0")
|
||||
.capabilities(capabilities)
|
||||
.tools(List.of(customTool))
|
||||
.resources(Map.of("custom://resource", customResource))
|
||||
.prompts(List.of(customPrompt))
|
||||
.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:
|
||||
- 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
|
||||
98
samples/spring-ai-mcp-sample/pom.xml
Normal file
98
samples/spring-ai-mcp-sample/pom.xml
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.springframework.experimental</groupId>
|
||||
<artifactId>mcp-parent</artifactId>
|
||||
<version>0.5.0-SNAPSHOT</version>
|
||||
</parent>
|
||||
|
||||
<artifactId>spring-ai-mcp-sample</artifactId>
|
||||
<name>Spring AI MCP Sample</name>
|
||||
<description>Sample Spring Boot application demonstrating MCP server usage</description>
|
||||
|
||||
<properties>
|
||||
<spring-boot.version>3.4.1</spring-boot.version>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.springframework.experimental</groupId>
|
||||
<artifactId>mcp-webflux-sse-transport</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.experimental</groupId>
|
||||
<artifactId>spring-ai-mcp</artifactId>
|
||||
<version>${project.version}</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-webflux</artifactId>
|
||||
<version>${spring-boot.version}</version>
|
||||
</dependency>
|
||||
<!-- <dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter</artifactId>
|
||||
<version>${spring-boot.version}</version>
|
||||
</dependency> -->
|
||||
|
||||
<!-- Jetty Server-->
|
||||
<!-- <dependency>
|
||||
<groupId>org.eclipse.jetty</groupId>
|
||||
<artifactId>jetty-server</artifactId>
|
||||
<version>11.0.15</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.eclipse.jetty</groupId>
|
||||
<artifactId>jetty-servlet</artifactId>
|
||||
<version>11.0.15</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>jakarta.servlet</groupId>
|
||||
<artifactId>jakarta.servlet-api</artifactId>
|
||||
<version>5.0.0</version>
|
||||
</dependency> -->
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<version>${spring-boot.version}</version>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||
<version>${spring-boot.version}</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<goals>
|
||||
<goal>repackage</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
<plugin>
|
||||
<groupId>io.spring.javaformat</groupId>
|
||||
<artifactId>spring-javaformat-maven-plugin</artifactId>
|
||||
<version>0.0.43</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<phase>validate</phase>
|
||||
<inherited>true</inherited>
|
||||
<goals>
|
||||
<goal>validate</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
/*
|
||||
* 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.client;
|
||||
|
||||
import org.springframework.ai.mcp.client.transport.WebFluxSseClientTransport;
|
||||
import org.springframework.web.reactive.function.client.WebClient;
|
||||
|
||||
/**
|
||||
* @author Christian Tzolov
|
||||
*/
|
||||
|
||||
public class ClientSse {
|
||||
|
||||
public static void main(String[] args) {
|
||||
var transport = new WebFluxSseClientTransport(WebClient.builder().baseUrl("http://localhost:8080"));
|
||||
|
||||
new SampleClient(transport).run();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
/*
|
||||
* 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.client;
|
||||
|
||||
import org.springframework.ai.mcp.client.transport.HttpClientSseClientTransport;
|
||||
|
||||
/**
|
||||
* @author Christian Tzolov
|
||||
*/
|
||||
|
||||
public class ClientSse2 {
|
||||
|
||||
public static void main(String[] args) {
|
||||
var transport = new HttpClientSseClientTransport("http://localhost:8080");
|
||||
|
||||
new SampleClient(transport).run();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -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.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: <pre>./mvnw clean install -DskipTests</pre>
|
||||
*/
|
||||
public class ClientStdio {
|
||||
|
||||
public static void main(String[] args) {
|
||||
|
||||
var stdioParams = ServerParameters.builder("java")
|
||||
.args("-Dtransport.mode=stdio", "-jar",
|
||||
"spring-ai-mcp-sample/target/spring-ai-mcp-sample-0.5.0-SNAPSHOT.jar")
|
||||
.build();
|
||||
|
||||
var transport = new StdioClientTransport(stdioParams);
|
||||
|
||||
new SampleClient(transport).run();
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,88 @@
|
|||
/*
|
||||
* 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.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;
|
||||
import org.springframework.ai.mcp.spec.McpTransport;
|
||||
|
||||
/**
|
||||
* @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 calcResponse = client
|
||||
.callTool(new CallToolRequest("calculator", Map.of("operation", "multiply", "a", 2.0, "b", 3.0)));
|
||||
System.out.println("Calculator Response = " + calcResponse);
|
||||
|
||||
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();
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
package org.springframework.ai.mcp.sample.server;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
|
||||
@SpringBootApplication
|
||||
public class McpServerApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(McpServerApplication.class, args);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,308 @@
|
|||
package org.springframework.ai.mcp.sample.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.StdioServerTransport;
|
||||
import org.springframework.ai.mcp.server.transport.WebFluxSseServerTransport;
|
||||
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.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.web.client.RestClient;
|
||||
import org.springframework.web.reactive.function.server.RouterFunction;
|
||||
|
||||
@Configuration
|
||||
public class McpServerConfig {
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(McpServerConfig.class);
|
||||
|
||||
// STDIO transport
|
||||
@Bean
|
||||
@ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "stdio")
|
||||
public StdioServerTransport stdioServerTransport() {
|
||||
return new StdioServerTransport();
|
||||
}
|
||||
|
||||
// SSE transport
|
||||
@Bean
|
||||
@ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse")
|
||||
public WebFluxSseServerTransport sseServerTransport() {
|
||||
return new WebFluxSseServerTransport(new ObjectMapper(), "/mcp/message");
|
||||
}
|
||||
|
||||
// Router function for SSE transport used by Spring WebFlux to start an HTTP
|
||||
// server.
|
||||
@Bean
|
||||
@ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse")
|
||||
public RouterFunction<?> mcpRouterFunction(WebFluxSseServerTransport transport) {
|
||||
return transport.getRouterFunction();
|
||||
}
|
||||
|
||||
// SSE transport
|
||||
// @Bean
|
||||
// @ConditionalOnProperty(prefix = "transport", name = "mode", havingValue = "sse2")
|
||||
// public HttpServletSseServerTransport sseServerTransport2() {
|
||||
// var httpTransport = new HttpServletSseServerTransport(new ObjectMapper(),
|
||||
// "/mcp/message");
|
||||
|
||||
// // Create and configure Jetty server
|
||||
// Server server = new Server(8080);
|
||||
|
||||
// ServletContextHandler context = new
|
||||
// ServletContextHandler(ServletContextHandler.SESSIONS);
|
||||
// context.setContextPath("/");
|
||||
// server.setHandler(context);
|
||||
|
||||
// // Add our SSE servlet
|
||||
// context.addServlet(new ServletHolder(httpTransport), "/sse");
|
||||
|
||||
// // Start the server
|
||||
// try {
|
||||
// server.start();
|
||||
// System.out.println("Server started on http://localhost:8080/sse");
|
||||
// server.join();
|
||||
// }
|
||||
// catch (Exception e) {
|
||||
// e.printStackTrace();
|
||||
// try {
|
||||
// server.stop();
|
||||
// }
|
||||
// catch (Exception e1) {
|
||||
// e1.printStackTrace();
|
||||
// }
|
||||
// }
|
||||
|
||||
// return httpTransport;
|
||||
// }
|
||||
|
||||
@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(calculatorToolRegistration(),
|
||||
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<String, String>() {
|
||||
@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<ToolRegistration> 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;
|
||||
});
|
||||
}
|
||||
|
||||
private static ToolRegistration calculatorToolRegistration() {
|
||||
return new ToolRegistration(new McpSchema.Tool("calculator",
|
||||
"Performs basic arithmetic operations (add, subtract, multiply, divide)", """
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"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"
|
||||
}
|
||||
},
|
||||
"required": ["operation", "a", "b"]
|
||||
}
|
||||
"""), arguments -> {
|
||||
String operation = (String) arguments.get("operation");
|
||||
double a = (Double) arguments.get("a");
|
||||
double b = (Double) arguments.get("b");
|
||||
|
||||
double result;
|
||||
switch (operation) {
|
||||
case "add":
|
||||
result = a + b;
|
||||
break;
|
||||
case "subtract":
|
||||
result = a - b;
|
||||
break;
|
||||
case "multiply":
|
||||
result = a * b;
|
||||
break;
|
||||
case "divide":
|
||||
if (b == 0) {
|
||||
return new McpSchema.CallToolResult(
|
||||
java.util.List.of(new McpSchema.TextContent("Division by zero")), true);
|
||||
}
|
||||
result = a / b;
|
||||
break;
|
||||
default:
|
||||
return new McpSchema.CallToolResult(
|
||||
java.util.List.of(new McpSchema.TextContent("Unknown operation: " + operation)),
|
||||
true);
|
||||
}
|
||||
|
||||
return new McpSchema.CallToolResult(
|
||||
java.util.List.of(new McpSchema.TextContent(String.valueOf(result))), false);
|
||||
});
|
||||
}
|
||||
|
||||
public static String paymentTransactionStatus(String transactionId, String accountName) {
|
||||
return "The status for " + transactionId + ", by " + accountName + " is PENDING";
|
||||
}
|
||||
|
||||
public Function<String, String> toUpperCase() {
|
||||
return String::toUpperCase;
|
||||
}
|
||||
|
||||
@Bean
|
||||
public OpenLibrary openLibrary() {
|
||||
return new OpenLibrary(RestClient.builder());
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -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.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<Map<String, Object>> docs) {
|
||||
}
|
||||
|
||||
public record Book(List<String> isbn, String title, List<String> authorName) {
|
||||
}
|
||||
|
||||
public List<Book> 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<String>) doc.get("isbn"), (String) doc.get("title"),
|
||||
(List<String>) doc.get("author_name")))
|
||||
.toList();
|
||||
}
|
||||
|
||||
public List<String> 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<Book> books = openLibrary.getBooks("Spring Framework");
|
||||
System.out.println(books);
|
||||
List<String> booksByAuthor = openLibrary.getBookTitlesByAuthor("Craig Walls");
|
||||
System.out.println(booksByAuthor);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
# spring.main.web-application-type=none
|
||||
|
||||
# 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
|
||||
Loading…
Reference in a new issue