Rename modules, update .gitignore
This commit is contained in:
Mark Pollack
parent
49e0291611
commit
910be3cee7
41 changed files with 71 additions and 156 deletions
|
|
@ -1,36 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
||||||
<modelVersion>4.0.0</modelVersion>
|
|
||||||
<groupId>org.springframework.experimental</groupId>
|
|
||||||
<artifactId>spring-ai-mcp</artifactId>
|
|
||||||
<version>0.0.1-SNAPSHOT</version>
|
|
||||||
<packaging>pom</packaging>
|
|
||||||
<name>mcp-parent</name>
|
|
||||||
<description>Demo project for Spring Boot</description>
|
|
||||||
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
|
||||||
<organization>
|
|
||||||
<name>VMware Inc.</name>
|
|
||||||
<url>https://spring.io</url>
|
|
||||||
</organization>
|
|
||||||
<licenses>
|
|
||||||
<license>
|
|
||||||
<name>Apache 2.0</name>
|
|
||||||
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
|
|
||||||
<distribution>repo</distribution>
|
|
||||||
</license>
|
|
||||||
</licenses>
|
|
||||||
<developers>
|
|
||||||
<developer>
|
|
||||||
<name>Christian Tzolov</name>
|
|
||||||
</developer>
|
|
||||||
<developer>
|
|
||||||
<name>Dariusz Jędrzejczyk</name>
|
|
||||||
</developer>
|
|
||||||
</developers>
|
|
||||||
<scm>
|
|
||||||
<connection>git://github.com/spring-projects-experimental/spring-ai-mcp.git</connection>
|
|
||||||
<developerConnection>git@github.com:spring-projects-experimental/spring-ai-mcp.git</developerConnection>
|
|
||||||
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
|
||||||
</scm>
|
|
||||||
</project>
|
|
||||||
53
.gitignore
vendored
53
.gitignore
vendored
|
|
@ -1,33 +1,64 @@
|
||||||
HELP.md
|
### Maven/Gradle Builds ###
|
||||||
target/
|
target/
|
||||||
!.mvn/wrapper/maven-wrapper.jar
|
!.mvn/wrapper/maven-wrapper.jar
|
||||||
!**/src/main/**/target/
|
!**/src/main/**/target/
|
||||||
!**/src/test/**/target/
|
!**/src/test/**/target/
|
||||||
|
build/
|
||||||
|
!**/src/main/**/build/
|
||||||
|
!**/src/test/**/build/
|
||||||
|
.gradle
|
||||||
|
out
|
||||||
|
/.gradletasknamecache
|
||||||
|
**/*.flattened-pom.xml
|
||||||
|
|
||||||
### STS ###
|
### IDE - Eclipse/STS ###
|
||||||
.apt_generated
|
.apt_generated
|
||||||
.classpath
|
.classpath
|
||||||
.factorypath
|
.factorypath
|
||||||
.project
|
.project
|
||||||
.settings
|
.settings/
|
||||||
.springBeans
|
.springBeans
|
||||||
.sts4-cache
|
.sts4-cache
|
||||||
|
bin/
|
||||||
|
com.springsource.sts.config.flow.prefs
|
||||||
|
|
||||||
### IntelliJ IDEA ###
|
### IDE - IntelliJ IDEA ###
|
||||||
.idea
|
.idea/
|
||||||
*.iws
|
|
||||||
*.iml
|
*.iml
|
||||||
*.ipr
|
*.ipr
|
||||||
|
*.iws
|
||||||
|
|
||||||
### NetBeans ###
|
### IDE - NetBeans ###
|
||||||
/nbproject/private/
|
/nbproject/private/
|
||||||
/nbbuild/
|
/nbbuild/
|
||||||
/dist/
|
/dist/
|
||||||
/nbdist/
|
/nbdist/
|
||||||
/.nb-gradle/
|
/.nb-gradle/
|
||||||
build/
|
|
||||||
!**/src/main/**/build/
|
|
||||||
!**/src/test/**/build/
|
|
||||||
|
|
||||||
### VS Code ###
|
### IDE - VS Code ###
|
||||||
.vscode/
|
.vscode/
|
||||||
|
vscode/
|
||||||
|
settings.json
|
||||||
|
|
||||||
|
### Logs and Databases ###
|
||||||
|
build.log
|
||||||
|
shell.log
|
||||||
|
integration-repo
|
||||||
|
ivy-cache
|
||||||
|
spring-build
|
||||||
|
derby-home
|
||||||
|
derbydb
|
||||||
|
derby.log
|
||||||
|
|
||||||
|
### Node.js ###
|
||||||
|
node/
|
||||||
|
node_modules/
|
||||||
|
package-lock.json
|
||||||
|
package.json
|
||||||
|
|
||||||
|
### Other ###
|
||||||
|
.antlr/
|
||||||
|
.profiler/
|
||||||
|
s3.properties
|
||||||
|
.*.swp
|
||||||
|
.DS_Store
|
||||||
|
|
@ -1,55 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
||||||
<modelVersion>4.0.0</modelVersion>
|
|
||||||
<groupId>org.springframework.experimental</groupId>
|
|
||||||
<artifactId>spring-ai-mcp-spring-boot</artifactId>
|
|
||||||
<version>0.0.1-SNAPSHOT</version>
|
|
||||||
<name>spring-ai-mcp-spring-boot</name>
|
|
||||||
<description>Spring AI MCP Spring Boot Integration</description>
|
|
||||||
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
|
||||||
<organization>
|
|
||||||
<name>VMware Inc.</name>
|
|
||||||
<url>https://spring.io</url>
|
|
||||||
</organization>
|
|
||||||
<licenses>
|
|
||||||
<license>
|
|
||||||
<name>Apache 2.0</name>
|
|
||||||
<url>https://www.apache.org/licenses/LICENSE-2.0.txt</url>
|
|
||||||
<distribution>repo</distribution>
|
|
||||||
</license>
|
|
||||||
</licenses>
|
|
||||||
<developers>
|
|
||||||
<developer>
|
|
||||||
<name>Christian Tzolov</name>
|
|
||||||
</developer>
|
|
||||||
<developer>
|
|
||||||
<name>Dariusz Jędrzejczyk</name>
|
|
||||||
</developer>
|
|
||||||
</developers>
|
|
||||||
<scm>
|
|
||||||
<connection>git://github.com/spring-projects-experimental/spring-ai-mcp.git</connection>
|
|
||||||
<developerConnection>git@github.com:spring-projects-experimental/spring-ai-mcp.git</developerConnection>
|
|
||||||
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
|
||||||
</scm>
|
|
||||||
<dependencies>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter</artifactId>
|
|
||||||
<version>3.3.6</version>
|
|
||||||
<scope>compile</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.ai</groupId>
|
|
||||||
<artifactId>spring-ai-openai-spring-boot-starter</artifactId>
|
|
||||||
<version>1.0.0-M4</version>
|
|
||||||
<scope>compile</scope>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.experimental</groupId>
|
|
||||||
<artifactId>spring-ai-mcp-spring</artifactId>
|
|
||||||
<version>0.0.1-SNAPSHOT</version>
|
|
||||||
<scope>compile</scope>
|
|
||||||
</dependency>
|
|
||||||
</dependencies>
|
|
||||||
</project>
|
|
||||||
8
pom.xml
8
pom.xml
|
|
@ -11,7 +11,7 @@
|
||||||
<packaging>pom</packaging>
|
<packaging>pom</packaging>
|
||||||
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
||||||
|
|
||||||
<name>mcp-parent</name>
|
<name>Spring AI MCP</name>
|
||||||
<description>Demo project for Spring Boot</description>
|
<description>Demo project for Spring Boot</description>
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -91,9 +91,9 @@
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<modules>
|
<modules>
|
||||||
<module>mcp-core</module>
|
<module>spring-ai-mcp-core</module>
|
||||||
<module>mcp-spring</module>
|
<module>spring-ai-mcp-spring</module>
|
||||||
<module>mcp-spring-boot</module>
|
<module>spring-ai-mcp-spring-boot</module>
|
||||||
</modules>
|
</modules>
|
||||||
|
|
||||||
<build>
|
<build>
|
||||||
|
|
|
||||||
24
settings.xml
Normal file
24
settings.xml
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
|
||||||
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
|
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
|
||||||
|
https://maven.apache.org/xsd/settings-1.0.0.xsd">
|
||||||
|
|
||||||
|
<servers>
|
||||||
|
<server>
|
||||||
|
<id>spring-snapshots</id>
|
||||||
|
<username>${env.ARTIFACTORY_USERNAME}</username>
|
||||||
|
<password>${env.ARTIFACTORY_PASSWORD}</password>
|
||||||
|
</server>
|
||||||
|
<server>
|
||||||
|
<id>spring-staging</id>
|
||||||
|
<username>${env.ARTIFACTORY_USERNAME}</username>
|
||||||
|
<password>${env.ARTIFACTORY_PASSWORD}</password>
|
||||||
|
</server>
|
||||||
|
<server>
|
||||||
|
<id>spring-milestones</id>
|
||||||
|
<username>${env.ARTIFACTORY_USERNAME}</username>
|
||||||
|
<password>${env.ARTIFACTORY_PASSWORD}</password>
|
||||||
|
</server>
|
||||||
|
</servers>
|
||||||
|
|
||||||
|
</settings>
|
||||||
|
|
@ -3,10 +3,10 @@
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<groupId>org.springframework.experimental</groupId>
|
<groupId>org.springframework.experimental</groupId>
|
||||||
<artifactId>spring-ai-mcp-spring</artifactId>
|
<artifactId>spring-ai-mcp-core</artifactId>
|
||||||
<version>0.0.1-SNAPSHOT</version>
|
<version>0.0.1-SNAPSHOT</version>
|
||||||
<name>Spring AI MCP Spring</name>
|
<name>Spring AI MCP Core</name>
|
||||||
<description>Spring Integration for MCP</description>
|
<description>Demo project for Spring Boot</description>
|
||||||
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
||||||
<organization>
|
<organization>
|
||||||
<name>VMware Inc.</name>
|
<name>VMware Inc.</name>
|
||||||
|
|
@ -34,15 +34,15 @@
|
||||||
</scm>
|
</scm>
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.ai</groupId>
|
<groupId>com.fasterxml.jackson.core</groupId>
|
||||||
<artifactId>spring-ai-core</artifactId>
|
<artifactId>jackson-databind</artifactId>
|
||||||
<version>1.0.0-M4</version>
|
<version>2.18.2</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.experimental</groupId>
|
<groupId>io.projectreactor</groupId>
|
||||||
<artifactId>spring-ai-mcp-core</artifactId>
|
<artifactId>reactor-core</artifactId>
|
||||||
<version>0.0.1-SNAPSHOT</version>
|
<version>3.7.0</version>
|
||||||
<scope>compile</scope>
|
<scope>compile</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
19
spring-ai-mcp-core/.mvn/wrapper/maven-wrapper.properties
vendored
Normal file
19
spring-ai-mcp-core/.mvn/wrapper/maven-wrapper.properties
vendored
Normal file
|
|
@ -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
|
||||||
198
spring-ai-mcp-core/README.md
Normal file
198
spring-ai-mcp-core/README.md
Normal file
|
|
@ -0,0 +1,198 @@
|
||||||
|
# Model Context Protocol (MCP) Java SDK
|
||||||
|
|
||||||
|
A Java implementation of the [Model Context Protocol](https://modelcontextprotocol.org/docs/concepts/architecture) specification, providing both synchronous and asynchronous clients for MCP server interactions.
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This SDK implements the Model Context Protocol, enabling seamless integration with AI models and tools through a standardized interface. It supports both synchronous and asynchronous communication patterns, making it suitable for various use cases and integration scenarios.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Synchronous and Asynchronous client implementations
|
||||||
|
- Standard MCP operations support:
|
||||||
|
- Tool discovery and execution
|
||||||
|
- Resource management and templates
|
||||||
|
- Prompt handling and management
|
||||||
|
- Resource subscription system
|
||||||
|
- Server initialization and ping
|
||||||
|
- Stdio-based server transport
|
||||||
|
- Reactive programming support using Project Reactor
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Add the following dependency to your Maven project:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>spring.ai.experimental</groupId>
|
||||||
|
<artifactId>mcp-core</artifactId>
|
||||||
|
<version>0.0.1-SNAPSHOT</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Async Client Example
|
||||||
|
|
||||||
|
```java
|
||||||
|
// Create server parameters
|
||||||
|
ServerParameters params = ServerParameters.builder("npx")
|
||||||
|
.args("-y", "@modelcontextprotocol/server-everything", "dir")
|
||||||
|
.build();
|
||||||
|
|
||||||
|
// Initialize the async client
|
||||||
|
Duration timeout = Duration.ofSeconds(10);
|
||||||
|
McpAsyncClient client = McpClient.async(
|
||||||
|
new StdioServerTransport(params),
|
||||||
|
timeout
|
||||||
|
);
|
||||||
|
|
||||||
|
// Initialize the connection
|
||||||
|
client.initialize()
|
||||||
|
.flatMap(result -> {
|
||||||
|
// Connection initialized
|
||||||
|
return client.listTools(null);
|
||||||
|
})
|
||||||
|
.flatMap(tools -> {
|
||||||
|
// Process tools
|
||||||
|
return client.callTool(new McpSchema.CallToolRequest("echo",
|
||||||
|
Map.of("message", "Hello MCP!")));
|
||||||
|
})
|
||||||
|
.flatMap(result -> {
|
||||||
|
// Handle tool result
|
||||||
|
return client.listPrompts(null);
|
||||||
|
})
|
||||||
|
.flatMap(prompts -> {
|
||||||
|
// Process available prompts
|
||||||
|
return client.getPrompt(new McpSchema.GetPromptRequest("prompt-id"));
|
||||||
|
})
|
||||||
|
.subscribe(prompt -> {
|
||||||
|
// Handle prompt result
|
||||||
|
});
|
||||||
|
|
||||||
|
// Resource management example
|
||||||
|
client.listResources(null)
|
||||||
|
.flatMap(resources -> {
|
||||||
|
// Subscribe to resource changes
|
||||||
|
return client.subscribeResource(new McpSchema.SubscribeRequest("resource-uri"));
|
||||||
|
})
|
||||||
|
.subscribe();
|
||||||
|
|
||||||
|
// Cleanup
|
||||||
|
client.closeGracefully(timeout).block();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Sync Client Example
|
||||||
|
|
||||||
|
```java
|
||||||
|
// Create and initialize sync client
|
||||||
|
McpSyncClient client = McpClient.sync(
|
||||||
|
new StdioServerTransport(params),
|
||||||
|
timeout
|
||||||
|
);
|
||||||
|
|
||||||
|
try {
|
||||||
|
// Initialize connection
|
||||||
|
McpSchema.InitializeResult initResult = client.initialize();
|
||||||
|
|
||||||
|
// List tools synchronously
|
||||||
|
McpSchema.ListToolsResult tools = client.listTools(null);
|
||||||
|
|
||||||
|
// Call tool synchronously
|
||||||
|
McpSchema.CallToolResult result = client.callTool(
|
||||||
|
new McpSchema.CallToolRequest("echo", Map.of("message", "Hello!"))
|
||||||
|
);
|
||||||
|
|
||||||
|
// Resource management
|
||||||
|
McpSchema.ListResourcesResult resources = client.listResources(null);
|
||||||
|
McpSchema.ReadResourceResult resource = client.readResource(
|
||||||
|
new McpSchema.ReadResourceRequest("resource-uri")
|
||||||
|
);
|
||||||
|
|
||||||
|
// Prompt management
|
||||||
|
ListPromptsResult prompts = client.listPrompts(null);
|
||||||
|
GetPromptResult prompt = client.getPrompt(
|
||||||
|
new McpSchema.GetPromptRequest("prompt-id")
|
||||||
|
);
|
||||||
|
} finally {
|
||||||
|
// Cleanup
|
||||||
|
client.close();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Architecture
|
||||||
|
|
||||||
|
The SDK follows a layered architecture:
|
||||||
|
|
||||||
|
### Core Components
|
||||||
|
|
||||||
|
- **McpClient**: Factory class for creating sync and async clients
|
||||||
|
- **McpAsyncClient**: Primary async implementation using Project Reactor
|
||||||
|
- **McpSyncClient**: Synchronous wrapper around the async client
|
||||||
|
- **McpSession**: Core session interface defining communication patterns
|
||||||
|
- **McpTransport**: Transport layer interface
|
||||||
|
- **McpSchema**: Comprehensive protocol schema definitions
|
||||||
|
- **AbstractMcpTransport**: Base transport implementation
|
||||||
|
- **StdioServerTransport**: Stdio-based server communication
|
||||||
|
|
||||||
|
### Key Interactions
|
||||||
|
|
||||||
|
1. Client initialization
|
||||||
|
- Transport setup
|
||||||
|
- Server connection establishment
|
||||||
|
- Protocol handshake
|
||||||
|
|
||||||
|
2. Message Flow
|
||||||
|
- JSON-RPC message creation
|
||||||
|
- Transport layer handling
|
||||||
|
- Response processing
|
||||||
|
- Error handling
|
||||||
|
|
||||||
|
3. Resource Management
|
||||||
|
- Resource listing and reading
|
||||||
|
- Template management
|
||||||
|
- Subscription handling
|
||||||
|
- Change notifications
|
||||||
|
|
||||||
|
4. Prompt System
|
||||||
|
- Prompt discovery
|
||||||
|
- Prompt retrieval
|
||||||
|
- Change notifications
|
||||||
|
|
||||||
|
5. Tool Execution
|
||||||
|
- Tool discovery
|
||||||
|
- Parameter validation
|
||||||
|
- Execution handling
|
||||||
|
- Result processing
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
The SDK provides comprehensive error handling through the McpError class:
|
||||||
|
|
||||||
|
- Transport-level errors
|
||||||
|
- Protocol violations
|
||||||
|
- Tool execution failures
|
||||||
|
- Resource access errors
|
||||||
|
- Subscription handling errors
|
||||||
|
- Prompt management errors
|
||||||
|
- Timeout handling
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
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.
|
||||||
259
spring-ai-mcp-core/mvnw
vendored
Executable file
259
spring-ai-mcp-core/mvnw
vendored
Executable file
|
|
@ -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-<version>,maven-mvnd-<version>-<platform>}/<hash>
|
||||||
|
[ -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 "$@"
|
||||||
149
spring-ai-mcp-core/mvnw.cmd
vendored
Normal file
149
spring-ai-mcp-core/mvnw.cmd
vendored
Normal file
|
|
@ -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-<version>,maven-mvnd-<version>-<platform>}/<hash>
|
||||||
|
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"
|
||||||
61
spring-ai-mcp-core/pom.xml
Normal file
61
spring-ai-mcp-core/pom.xml
Normal file
|
|
@ -0,0 +1,61 @@
|
||||||
|
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
<parent>
|
||||||
|
<groupId>org.springframework.experimental</groupId>
|
||||||
|
<artifactId>spring-ai-mcp</artifactId>
|
||||||
|
<version>0.0.1-SNAPSHOT</version>
|
||||||
|
</parent>
|
||||||
|
<artifactId>spring-ai-mcp-core</artifactId>
|
||||||
|
<packaging>jar</packaging>
|
||||||
|
<name>Spring AI MCP Core</name>
|
||||||
|
<description>Demo project for Spring Boot</description>
|
||||||
|
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
||||||
|
|
||||||
|
<scm>
|
||||||
|
<url>https://github.com/spring-projects-experimental/spring-ai-mcp</url>
|
||||||
|
<connection>git://github.com/spring-projects-experimental/spring-ai-mcp.git</connection>
|
||||||
|
<developerConnection>git@github.com:spring-projects-experimental/spring-ai-mcp.git</developerConnection>
|
||||||
|
</scm>
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.fasterxml.jackson.core</groupId>
|
||||||
|
<artifactId>jackson-databind</artifactId>
|
||||||
|
<version>2.18.2</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.projectreactor</groupId>
|
||||||
|
<artifactId>reactor-core</artifactId>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.assertj</groupId>
|
||||||
|
<artifactId>assertj-core</artifactId>
|
||||||
|
<version>${assert4j.version}</version>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.junit.jupiter</groupId>
|
||||||
|
<artifactId>junit-jupiter-api</artifactId>
|
||||||
|
<version>${junit.version}</version>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.mockito</groupId>
|
||||||
|
<artifactId>mockito-core</artifactId>
|
||||||
|
<version>${mockito.version}</version>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.projectreactor</groupId>
|
||||||
|
<artifactId>reactor-test</artifactId>
|
||||||
|
<scope>test</scope>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
</dependencies>
|
||||||
|
|
||||||
|
|
||||||
|
</project>
|
||||||
|
|
@ -0,0 +1,246 @@
|
||||||
|
package spring.ai.experimental.mcp.client;
|
||||||
|
|
||||||
|
import java.time.Duration;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import reactor.core.publisher.Mono;
|
||||||
|
import spring.ai.experimental.mcp.spec.DefaultMcpSession;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpTransport;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpError;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.GetPromptRequest;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.GetPromptResult;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.ListPromptsResult;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.PaginatedRequest;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
* @author Christian Tzolov
|
||||||
|
*/
|
||||||
|
public class McpAsyncClient extends DefaultMcpSession {
|
||||||
|
|
||||||
|
private static TypeReference<Void> VOID_TYPE_REFERENCE = new TypeReference<Void>() {
|
||||||
|
};
|
||||||
|
|
||||||
|
public McpAsyncClient(McpTransport transport) {
|
||||||
|
this(transport, Duration.ofSeconds(10), new ObjectMapper());
|
||||||
|
}
|
||||||
|
|
||||||
|
public McpAsyncClient(McpTransport transport, Duration requestTimeout, ObjectMapper objectMapper) {
|
||||||
|
super(requestTimeout, objectMapper, transport);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The initialization phase MUST be the first interaction between client and
|
||||||
|
* server.
|
||||||
|
* During this phase, the client and server:
|
||||||
|
* <ul>
|
||||||
|
* <li>Establish protocol version compatibility</li>
|
||||||
|
* <li>Exchange and negotiate capabilities</li>
|
||||||
|
* <li>Share implementation details</li>
|
||||||
|
* </ul>
|
||||||
|
* <br/>
|
||||||
|
* The client MUST initiate this phase by sending an initialize request
|
||||||
|
* containing:
|
||||||
|
* <ul>
|
||||||
|
* <li>The protocol version the client supports</li>
|
||||||
|
* <li>The client's capabilities</li>
|
||||||
|
* <li>Client implementation information</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* The server MUST respond with its own capabilities and information:
|
||||||
|
* {@link McpSchema.ServerCapabilities}. <br/>
|
||||||
|
* After successful initialization, the client MUST send an initialized
|
||||||
|
* notification
|
||||||
|
* to indicate it is ready to begin normal operations.
|
||||||
|
*
|
||||||
|
* <br/>
|
||||||
|
*
|
||||||
|
* <a href=
|
||||||
|
* "https://github.com/modelcontextprotocol/specification/blob/main/docs/specification/basic/lifecycle.md#initialization">Initialization
|
||||||
|
* Spec</a>
|
||||||
|
*
|
||||||
|
* @return the initialize result.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.InitializeResult> initialize() {
|
||||||
|
McpSchema.InitializeRequest initializeRequest = new McpSchema.InitializeRequest(// @formatter:off
|
||||||
|
McpSchema.LATEST_PROTOCOL_VERSION,
|
||||||
|
new McpSchema.ClientCapabilities(null, new McpSchema.ClientCapabilities.RootCapabilities(true), null),
|
||||||
|
new McpSchema.Implementation("mcp-java-client", "0.0.1")); // @formatter:on
|
||||||
|
|
||||||
|
Mono<McpSchema.InitializeResult> result = this.sendRequest("initialize", initializeRequest,
|
||||||
|
new TypeReference<McpSchema.InitializeResult>() {
|
||||||
|
});
|
||||||
|
|
||||||
|
return result.flatMap(initializeResult -> {
|
||||||
|
if (!McpSchema.LATEST_PROTOCOL_VERSION.equals(initializeResult.protocolVersion())) {
|
||||||
|
return Mono.error(
|
||||||
|
new McpError("Unsupported protocol version from the server: "
|
||||||
|
+ initializeResult.protocolVersion()));
|
||||||
|
} else {
|
||||||
|
return this.sendNotification("notifications/initialized", null)
|
||||||
|
.thenReturn(initializeResult);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a roots/list_changed notification.
|
||||||
|
*/
|
||||||
|
public Mono<Void> sendRootsListChanged() {
|
||||||
|
return this.sendNotification("notifications/roots/list_changed");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a synchronous ping request.
|
||||||
|
*/
|
||||||
|
public Mono<Void> ping() {
|
||||||
|
return this.sendRequest("ping", null, VOID_TYPE_REFERENCE);
|
||||||
|
}
|
||||||
|
|
||||||
|
// --------------------------
|
||||||
|
// Tools
|
||||||
|
// --------------------------
|
||||||
|
private static TypeReference<McpSchema.CallToolResult> CALL_TOOL_RESULT_TYPE_REF = new TypeReference<McpSchema.CallToolResult>() {
|
||||||
|
};
|
||||||
|
private static TypeReference<McpSchema.ListToolsResult> LIST_TOOLS_RESULT_TYPE_REF = new TypeReference<McpSchema.ListToolsResult>() {
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a tools/call request.
|
||||||
|
*
|
||||||
|
* @param callToolRequest the call tool request.
|
||||||
|
* @return the call tool result.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.CallToolResult> callTool(McpSchema.CallToolRequest callToolRequest) {
|
||||||
|
return this.sendRequest("tools/call", callToolRequest, CALL_TOOL_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a tools/list request.
|
||||||
|
*
|
||||||
|
* @return the list of tools result.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.ListToolsResult> listTools(String cursor) {
|
||||||
|
return this.sendRequest("tools/list", new McpSchema.PaginatedRequest(cursor), LIST_TOOLS_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
// --------------------------
|
||||||
|
// Resources
|
||||||
|
// --------------------------
|
||||||
|
|
||||||
|
private static TypeReference<McpSchema.ListResourcesResult> LIST_RESOURCES_RESULT_TYPE_REF = new TypeReference<McpSchema.ListResourcesResult>() {
|
||||||
|
};
|
||||||
|
private static TypeReference<McpSchema.ReadResourceResult> READ_RESOURCE_RESULT_TYPE_REF = new TypeReference<McpSchema.ReadResourceResult>() {
|
||||||
|
};
|
||||||
|
private static TypeReference<McpSchema.ListResourceTemplatesResult> LIST_RESOURCE_TEMPLATES_RESULT_TYPE_REF = new TypeReference<McpSchema.ListResourceTemplatesResult>() {
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/list request.
|
||||||
|
*
|
||||||
|
* @param cursor the cursor
|
||||||
|
* @return the list of resources result.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.ListResourcesResult> listResources(String cursor) {
|
||||||
|
return this.sendRequest("resources/list", new McpSchema.PaginatedRequest(cursor),
|
||||||
|
LIST_RESOURCES_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/read request.
|
||||||
|
*
|
||||||
|
* @param resource the resource to read
|
||||||
|
* @return the resource content.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.ReadResourceResult> readResource(McpSchema.Resource resource) {
|
||||||
|
return this.readResource(new McpSchema.ReadResourceRequest(resource.uri()));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/read request.
|
||||||
|
*
|
||||||
|
* @param readResourceRequest the read resource request.
|
||||||
|
* @return the resource content.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.ReadResourceResult> readResource(McpSchema.ReadResourceRequest readResourceRequest) {
|
||||||
|
return this.sendRequest("resources/read", readResourceRequest, READ_RESOURCE_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resource templates allow servers to expose parameterized resources using URI
|
||||||
|
* templates. Arguments may be auto-completed through the completion API.
|
||||||
|
*
|
||||||
|
* Request a list of resource templates the server has.
|
||||||
|
*
|
||||||
|
* @param cursor the cursor
|
||||||
|
* @return the list of resource templates result.
|
||||||
|
*/
|
||||||
|
public Mono<McpSchema.ListResourceTemplatesResult> listResourceTemplates(String cursor) {
|
||||||
|
return this.sendRequest("resources/templates/list", new McpSchema.PaginatedRequest(cursor),
|
||||||
|
LIST_RESOURCE_TEMPLATES_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List Changed Notification. When the list of available resources changes,
|
||||||
|
* servers that declared the listChanged capability SHOULD send a notification:
|
||||||
|
*/
|
||||||
|
public Mono<Void> sendResourcesListChanged() {
|
||||||
|
return this.sendNotification("notifications/resources/list_changed");
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Subscriptions. The protocol supports optional subscriptions to resource
|
||||||
|
* changes.
|
||||||
|
* Clients can subscribe to specific resources and receive notifications when
|
||||||
|
* they change.
|
||||||
|
*
|
||||||
|
* Send a resources/subscribe request.
|
||||||
|
*
|
||||||
|
* @param subscribeRequest the subscribe request contains the uri of the
|
||||||
|
* resource to subscribe to.
|
||||||
|
*/
|
||||||
|
public Mono<Void> subscribeResource(McpSchema.SubscribeRequest subscribeRequest) {
|
||||||
|
return this.sendRequest("resources/subscribe", subscribeRequest, VOID_TYPE_REFERENCE);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/unsubscribe request.
|
||||||
|
*
|
||||||
|
* @param unsubscribeRequest the unsubscribe request contains the uri of the
|
||||||
|
* resource to unsubscribe from.
|
||||||
|
*/
|
||||||
|
public Mono<Void> unsubscribeResource(McpSchema.UnsubscribeRequest unsubscribeRequest) {
|
||||||
|
return this.sendRequest("resources/unsubscribe", unsubscribeRequest, VOID_TYPE_REFERENCE);
|
||||||
|
}
|
||||||
|
|
||||||
|
// --------------------------
|
||||||
|
// Prompts
|
||||||
|
// --------------------------
|
||||||
|
private static TypeReference<McpSchema.ListPromptsResult> LIST_PROMPTS_RESULT_TYPE_REF = new TypeReference<McpSchema.ListPromptsResult>() {
|
||||||
|
};
|
||||||
|
private static TypeReference<McpSchema.GetPromptResult> GET_PROMPT_RESULT_TYPE_REF = new TypeReference<McpSchema.GetPromptResult>() {
|
||||||
|
};
|
||||||
|
|
||||||
|
public Mono<ListPromptsResult> listPrompts(String cursor) {
|
||||||
|
return this
|
||||||
|
.sendRequest("prompts/list", new PaginatedRequest(cursor), LIST_PROMPTS_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
public Mono<GetPromptResult> getPrompt(GetPromptRequest getPromptRequest) {
|
||||||
|
return this.sendRequest("prompts/get", getPromptRequest, GET_PROMPT_RESULT_TYPE_REF);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Server) An optional notification from the server to the client, informing it
|
||||||
|
* that
|
||||||
|
* the list of prompts it offers has changed. This may be issued by servers
|
||||||
|
* without
|
||||||
|
* any previous subscription from the client.
|
||||||
|
*/
|
||||||
|
public Mono<Void> promptListChangedNotification() {
|
||||||
|
return this.sendNotification("notifications/prompts/list_changed");
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,105 @@
|
||||||
|
/*
|
||||||
|
* 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 spring.ai.experimental.mcp.client;
|
||||||
|
|
||||||
|
import java.time.Duration;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpTransport;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Factory class providing static methods for creating Model Context Protocol (MCP) clients.
|
||||||
|
* This class serves as the main entry point for establishing connections with MCP servers,
|
||||||
|
* offering both synchronous and asynchronous client implementations.
|
||||||
|
*
|
||||||
|
* <p>The class provides factory methods to create either:
|
||||||
|
* <ul>
|
||||||
|
* <li>{@link McpAsyncClient} for non-blocking operations
|
||||||
|
* <li>{@link McpSyncClient} for blocking operations
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* <p>Each client type can be instantiated with default settings or with custom configuration
|
||||||
|
* including request timeout and JSON object mapping.
|
||||||
|
*
|
||||||
|
* <p>Future implementations will introduce a builder pattern for more flexible client configuration.
|
||||||
|
*
|
||||||
|
* @author Christian Tzolov
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
*/
|
||||||
|
public class McpClient {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Private constructor to prevent instantiation as this is a utility class
|
||||||
|
* containing only static factory methods.
|
||||||
|
*/
|
||||||
|
private McpClient() {
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: introduce a builder like:
|
||||||
|
// McpClient.using(transport)
|
||||||
|
// .withRequestTimeout(Duration.ofSeconds(5))
|
||||||
|
// .withObjectMapper(objectMapper); <- or even a more sophisticated
|
||||||
|
// JSONtoPOJOCodec type
|
||||||
|
// .sync();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an asynchronous MCP client with default configuration.
|
||||||
|
*
|
||||||
|
* @param transport The transport layer implementation for MCP communication
|
||||||
|
* @return A new instance of {@link McpAsyncClient}
|
||||||
|
*/
|
||||||
|
public static McpAsyncClient async(McpTransport transport) {
|
||||||
|
return new McpAsyncClient(transport);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates an asynchronous MCP client with custom configuration.
|
||||||
|
*
|
||||||
|
* @param transport The transport layer implementation for MCP communication
|
||||||
|
* @param requestTimeout The duration to wait before timing out requests
|
||||||
|
* @param objectMapper The Jackson object mapper for JSON serialization/deserialization
|
||||||
|
* @return A new instance of {@link McpAsyncClient}
|
||||||
|
*/
|
||||||
|
public static McpAsyncClient async(McpTransport transport, Duration requestTimeout,
|
||||||
|
ObjectMapper objectMapper) {
|
||||||
|
return new McpAsyncClient(transport, requestTimeout, objectMapper);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a synchronous MCP client with default configuration.
|
||||||
|
* This method wraps an asynchronous client to provide synchronous operations.
|
||||||
|
*
|
||||||
|
* @param transport The transport layer implementation for MCP communication
|
||||||
|
* @return A new instance of {@link McpSyncClient}
|
||||||
|
*/
|
||||||
|
public static McpSyncClient sync(McpTransport transport) {
|
||||||
|
return new McpSyncClient(async(transport));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates a synchronous MCP client with custom configuration.
|
||||||
|
* This method wraps an asynchronous client to provide synchronous operations.
|
||||||
|
*
|
||||||
|
* @param transport The transport layer implementation for MCP communication
|
||||||
|
* @param requestTimeout The duration to wait before timing out requests
|
||||||
|
* @param objectMapper The Jackson object mapper for JSON serialization/deserialization
|
||||||
|
* @return A new instance of {@link McpSyncClient}
|
||||||
|
*/
|
||||||
|
public static McpSyncClient sync(McpTransport transport, Duration requestTimeout,
|
||||||
|
ObjectMapper objectMapper) {
|
||||||
|
return new McpSyncClient(async(transport, requestTimeout, objectMapper));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,208 @@
|
||||||
|
package spring.ai.experimental.mcp.client;
|
||||||
|
|
||||||
|
import java.time.Duration;
|
||||||
|
|
||||||
|
import spring.ai.experimental.mcp.client.util.Assert;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.GetPromptRequest;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.GetPromptResult;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.ListPromptsResult;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
* @author Christian Tzolov
|
||||||
|
*/
|
||||||
|
public class McpSyncClient implements AutoCloseable {
|
||||||
|
|
||||||
|
// TODO: Consider providing a client config to set this properly
|
||||||
|
// this is currently a concern only because AutoCloseable is used - perhaps it
|
||||||
|
// is not a requirement?
|
||||||
|
private static final long DEFAULT_CLOSE_TIMEOUT_MS = 10_000L;
|
||||||
|
|
||||||
|
private final McpAsyncClient delegate;
|
||||||
|
|
||||||
|
public McpSyncClient(McpAsyncClient delegate) {
|
||||||
|
Assert.notNull(delegate, "The delegate can not be null");
|
||||||
|
this.delegate = delegate;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void close() {
|
||||||
|
this.delegate.closeGracefully(Duration.ofMillis(DEFAULT_CLOSE_TIMEOUT_MS)).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The initialization phase MUST be the first interaction between client and
|
||||||
|
* server.
|
||||||
|
* During this phase, the client and server:
|
||||||
|
* <ul>
|
||||||
|
* <li>Establish protocol version compatibility</li>
|
||||||
|
* <li>Exchange and negotiate capabilities</li>
|
||||||
|
* <li>Share implementation details</li>
|
||||||
|
* </ul>
|
||||||
|
* <br/>
|
||||||
|
* The client MUST initiate this phase by sending an initialize request
|
||||||
|
* containing:
|
||||||
|
* <ul>
|
||||||
|
* <li>The protocol version the client supports</li>
|
||||||
|
* <li>The client's capabilities</li>
|
||||||
|
* <li>Client implementation information</li>
|
||||||
|
* </ul>
|
||||||
|
*
|
||||||
|
* The server MUST respond with its own capabilities and information:
|
||||||
|
* {@link McpSchema.ServerCapabilities}. <br/>
|
||||||
|
* After successful initialization, the client MUST send an initialized
|
||||||
|
* notification
|
||||||
|
* to indicate it is ready to begin normal operations.
|
||||||
|
*
|
||||||
|
* <br/>
|
||||||
|
*
|
||||||
|
* <a href=
|
||||||
|
* "https://github.com/modelcontextprotocol/specification/blob/main/docs/specification/basic/lifecycle.md#initialization">Initialization
|
||||||
|
* Spec</a>
|
||||||
|
*
|
||||||
|
* @return the initialize result.
|
||||||
|
*/
|
||||||
|
public McpSchema.InitializeResult initialize() {
|
||||||
|
// TODO: block takes no argument here as we assume the async client is
|
||||||
|
// configured with a requestTimeout at all times
|
||||||
|
return this.delegate.initialize().block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a roots/list_changed notification.
|
||||||
|
*/
|
||||||
|
public void sendRootsListChanged() {
|
||||||
|
this.delegate.sendRootsListChanged().block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a synchronous ping request.
|
||||||
|
*/
|
||||||
|
public void ping() {
|
||||||
|
this.delegate.ping().block();
|
||||||
|
}
|
||||||
|
|
||||||
|
// --------------------------
|
||||||
|
// Tools
|
||||||
|
// --------------------------
|
||||||
|
/**
|
||||||
|
* Send a tools/call request.
|
||||||
|
*
|
||||||
|
* @param callToolRequest the call tool request.
|
||||||
|
* @return the call tool result.
|
||||||
|
*/
|
||||||
|
public McpSchema.CallToolResult callTool(McpSchema.CallToolRequest callToolRequest) {
|
||||||
|
return this.delegate.callTool(callToolRequest).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a tools/list request.
|
||||||
|
*
|
||||||
|
* @return the list of tools result.
|
||||||
|
*/
|
||||||
|
public McpSchema.ListToolsResult listTools(String cursor) {
|
||||||
|
return this.delegate.listTools(cursor).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
// --------------------------
|
||||||
|
// Resources
|
||||||
|
// --------------------------
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/list request.
|
||||||
|
*
|
||||||
|
* @param cursor the cursor
|
||||||
|
* @return the list of resources result.
|
||||||
|
*/
|
||||||
|
public McpSchema.ListResourcesResult listResources(String cursor) {
|
||||||
|
return this.delegate.listResources(cursor).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/read request.
|
||||||
|
*
|
||||||
|
* @param resource the resource to read
|
||||||
|
* @return the resource content.
|
||||||
|
*/
|
||||||
|
public McpSchema.ReadResourceResult readResource(McpSchema.Resource resource) {
|
||||||
|
return this.delegate.readResource(resource).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/read request.
|
||||||
|
*
|
||||||
|
* @param readResourceRequest the read resource request.
|
||||||
|
* @return the resource content.
|
||||||
|
*/
|
||||||
|
public McpSchema.ReadResourceResult readResource(McpSchema.ReadResourceRequest readResourceRequest) {
|
||||||
|
return this.delegate.readResource(readResourceRequest).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resource templates allow servers to expose parameterized resources using URI
|
||||||
|
* templates. Arguments may be auto-completed through the completion API.
|
||||||
|
*
|
||||||
|
* Request a list of resource templates the server has.
|
||||||
|
*
|
||||||
|
* @param cursor the cursor
|
||||||
|
* @return the list of resource templates result.
|
||||||
|
*/
|
||||||
|
public McpSchema.ListResourceTemplatesResult listResourceTemplates(String cursor) {
|
||||||
|
return this.delegate.listResourceTemplates(cursor).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* List Changed Notification. When the list of available resources changes,
|
||||||
|
* servers
|
||||||
|
* that declared the listChanged capability SHOULD send a notification:
|
||||||
|
*/
|
||||||
|
public void sendResourcesListChanged() {
|
||||||
|
this.delegate.sendResourcesListChanged().block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Subscriptions. The protocol supports optional subscriptions to resource
|
||||||
|
* changes. Clients can subscribe to specific resources and receive
|
||||||
|
* notifications when they change.
|
||||||
|
*
|
||||||
|
* Send a resources/subscribe request.
|
||||||
|
*
|
||||||
|
* @param subscribeRequest the subscribe request contains the uri of the
|
||||||
|
* resource to subscribe to.
|
||||||
|
*/
|
||||||
|
public void subscribeResource(McpSchema.SubscribeRequest subscribeRequest) {
|
||||||
|
this.delegate.subscribeResource(subscribeRequest).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a resources/unsubscribe request.
|
||||||
|
*
|
||||||
|
* @param unsubscribeRequest the unsubscribe request contains the uri of the
|
||||||
|
* resource
|
||||||
|
* to unsubscribe from.
|
||||||
|
*/
|
||||||
|
public void unsubscribeResource(McpSchema.UnsubscribeRequest unsubscribeRequest) {
|
||||||
|
this.delegate.unsubscribeResource(unsubscribeRequest).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
// --------------------------
|
||||||
|
// Prompts
|
||||||
|
// --------------------------
|
||||||
|
public ListPromptsResult listPrompts(String cursor) {
|
||||||
|
return this.delegate.listPrompts(cursor).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
public GetPromptResult getPrompt(GetPromptRequest getPromptRequest) {
|
||||||
|
return this.delegate.getPrompt(getPromptRequest).block();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* (Server) An optional notification from the server to the client, informing it
|
||||||
|
* that the list of prompts it offers has changed. This may be issued by servers
|
||||||
|
* without any previous subscription from the client.
|
||||||
|
*/
|
||||||
|
public void promptListChangedNotification() {
|
||||||
|
this.delegate.promptListChangedNotification().block();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,133 @@
|
||||||
|
package spring.ai.experimental.mcp.client.stdio;
|
||||||
|
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Arrays;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.annotation.JsonInclude;
|
||||||
|
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||||
|
import spring.ai.experimental.mcp.client.util.Assert;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Server parameters for stdio client.
|
||||||
|
*
|
||||||
|
* @author Christian Tzolov
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
*/
|
||||||
|
@JsonInclude(JsonInclude.Include.NON_ABSENT)
|
||||||
|
public class ServerParameters {
|
||||||
|
|
||||||
|
// Environment variables to inherit by default
|
||||||
|
private static final List<String> DEFAULT_INHERITED_ENV_VARS = System.getProperty("os.name")
|
||||||
|
.toLowerCase()
|
||||||
|
.contains("win")
|
||||||
|
? Arrays.asList("APPDATA", "HOMEDRIVE", "HOMEPATH", "LOCALAPPDATA", "PATH",
|
||||||
|
"PROCESSOR_ARCHITECTURE", "SYSTEMDRIVE", "SYSTEMROOT", "TEMP", "USERNAME", "USERPROFILE")
|
||||||
|
: Arrays.asList("HOME", "LOGNAME", "PATH", "SHELL", "TERM", "USER");
|
||||||
|
|
||||||
|
@JsonProperty("command")
|
||||||
|
private String command;
|
||||||
|
|
||||||
|
@JsonProperty("args")
|
||||||
|
private List<String> args = new ArrayList<>();
|
||||||
|
|
||||||
|
@JsonProperty("env")
|
||||||
|
private Map<String, String> env;
|
||||||
|
|
||||||
|
private ServerParameters(String command, List<String> args, Map<String, String> env) {
|
||||||
|
Assert.notNull(command, "The command can not be null");
|
||||||
|
Assert.notNull(args, "The args can not be null");
|
||||||
|
|
||||||
|
this.command = command;
|
||||||
|
this.args = args;
|
||||||
|
this.env = new HashMap<>(getDefaultEnvironment());
|
||||||
|
if (env != null && !env.isEmpty()) {
|
||||||
|
this.env.putAll(env);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public String getCommand() {
|
||||||
|
return this.command;
|
||||||
|
}
|
||||||
|
|
||||||
|
public List<String> getArgs() {
|
||||||
|
return this.args;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Map<String, String> getEnv() {
|
||||||
|
return this.env;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static Builder builder(String command) {
|
||||||
|
return new Builder(command);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static class Builder {
|
||||||
|
|
||||||
|
private String command;
|
||||||
|
|
||||||
|
private List<String> args = new ArrayList<>();
|
||||||
|
|
||||||
|
private Map<String, String> env = new HashMap<>();
|
||||||
|
|
||||||
|
public Builder(String command) {
|
||||||
|
Assert.notNull(command, "The command can not be null");
|
||||||
|
this.command = command;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Builder args(String... args) {
|
||||||
|
Assert.notNull(args, "The args can not be null");
|
||||||
|
this.args = Arrays.asList(args);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Builder args(List<String> args) {
|
||||||
|
Assert.notNull(args, "The args can not be null");
|
||||||
|
this.args = new ArrayList<>(args);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Builder arg(String arg) {
|
||||||
|
Assert.notNull(arg, "The arg can not be null");
|
||||||
|
this.args.add(arg);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Builder env(Map<String, String> env) {
|
||||||
|
if (env != null && !env.isEmpty()) {
|
||||||
|
this.env.putAll(env);
|
||||||
|
}
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public Builder addEnvVar(String key, String value) {
|
||||||
|
Assert.notNull(key, "The key can not be null");
|
||||||
|
Assert.notNull(value, "The value can not be null");
|
||||||
|
this.env.put(key, value);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public ServerParameters build() {
|
||||||
|
return new ServerParameters(command, args, env);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a default environment object including only environment variables
|
||||||
|
* deemed safe to inherit.
|
||||||
|
*/
|
||||||
|
private static Map<String, String> getDefaultEnvironment() {
|
||||||
|
return System.getenv()
|
||||||
|
.entrySet()
|
||||||
|
.stream()
|
||||||
|
.filter(entry -> DEFAULT_INHERITED_ENV_VARS.contains(entry.getKey()))
|
||||||
|
.filter(entry -> entry.getValue() != null)
|
||||||
|
.filter(entry -> !entry.getValue().startsWith("()"))
|
||||||
|
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -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 spring.ai.experimental.mcp.client.stdio;
|
||||||
|
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.annotation.JsonInclude;
|
||||||
|
import com.fasterxml.jackson.annotation.JsonProperty;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import spring.ai.experimental.mcp.client.stdio.ServerParametersParser.McpServerConfigurations.McpServerConfiguration;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Christian Tzolov
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
*/
|
||||||
|
|
||||||
|
public class ServerParametersParser {
|
||||||
|
|
||||||
|
@JsonInclude(JsonInclude.Include.NON_ABSENT)
|
||||||
|
public record McpServerConfigurations(// @formatter:off
|
||||||
|
@JsonProperty("mcpServers") Map<String, McpServerConfiguration> mcpServers) {
|
||||||
|
|
||||||
|
@JsonInclude(JsonInclude.Include.NON_ABSENT)
|
||||||
|
public record McpServerConfiguration(
|
||||||
|
@JsonProperty("command") String command,
|
||||||
|
@JsonProperty("args") List<String> args,
|
||||||
|
@JsonProperty("env") Map<String, String> env) {
|
||||||
|
}
|
||||||
|
} // @formatter:on
|
||||||
|
|
||||||
|
public static void main(String[] args) throws Exception {
|
||||||
|
ObjectMapper objectMapper = new ObjectMapper();
|
||||||
|
|
||||||
|
// Assuming the JSON is in a file named "servers.json"
|
||||||
|
String jsonInput = """
|
||||||
|
{
|
||||||
|
"mcpServers": {
|
||||||
|
"filesystem": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@modelcontextprotocol/server-filesystem", "/path/to/allowed/files"]
|
||||||
|
},
|
||||||
|
"git": {
|
||||||
|
"command": "uvx",
|
||||||
|
"args": ["mcp-server-git", "--repository", "path/to/git/repo"]
|
||||||
|
},
|
||||||
|
"github": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@modelcontextprotocol/server-github"],
|
||||||
|
"env": {
|
||||||
|
"GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"postgres": {
|
||||||
|
"command": "npx",
|
||||||
|
"args": ["-y", "@modelcontextprotocol/server-postgres", "postgresql://localhost/mydb"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
""";
|
||||||
|
|
||||||
|
// Deserialize JSON into McpServers
|
||||||
|
McpServerConfigurations servers = objectMapper.readValue(jsonInput, McpServerConfigurations.class);
|
||||||
|
|
||||||
|
// Access individual servers
|
||||||
|
for (Map.Entry<String, McpServerConfiguration> entry : servers.mcpServers().entrySet()) {
|
||||||
|
System.out.println("Key: " + entry.getKey());
|
||||||
|
System.out.println("Command: " + entry.getValue().command());
|
||||||
|
System.out.println("Arguments: " + String.join(", ", entry.getValue().args()));
|
||||||
|
System.out.println("Environment Variables: " + entry.getValue().env());
|
||||||
|
System.out.println("-----------");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,245 @@
|
||||||
|
package spring.ai.experimental.mcp.client.stdio;
|
||||||
|
|
||||||
|
import java.io.BufferedReader;
|
||||||
|
import java.io.BufferedWriter;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.concurrent.Executors;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.core.type.TypeReference;
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import reactor.core.publisher.Mono;
|
||||||
|
import reactor.core.scheduler.Scheduler;
|
||||||
|
import reactor.core.scheduler.Schedulers;
|
||||||
|
import spring.ai.experimental.mcp.client.util.Assert;
|
||||||
|
import spring.ai.experimental.mcp.spec.AbstractMcpTransport;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.JSONRPCMessage;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.JSONRPCNotification;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.JSONRPCRequest;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.JSONRPCResponse;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stdio client for communicating with a server process.
|
||||||
|
*
|
||||||
|
* @author Christian Tzolov
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
*/
|
||||||
|
public class StdioServerTransport extends AbstractMcpTransport {
|
||||||
|
|
||||||
|
private final static TypeReference<HashMap<String, Object>> MAP_TYPE_REF = new TypeReference<HashMap<String, Object>>() {
|
||||||
|
};
|
||||||
|
|
||||||
|
private Process process;
|
||||||
|
|
||||||
|
private BufferedReader processErrorReader;
|
||||||
|
private BufferedReader processReader;
|
||||||
|
private BufferedWriter processWriter;
|
||||||
|
|
||||||
|
private Scheduler inboundScheduler;
|
||||||
|
private Scheduler outboundScheduler;
|
||||||
|
private Scheduler errorScheduler;
|
||||||
|
|
||||||
|
volatile boolean isRunning;
|
||||||
|
|
||||||
|
private final ServerParameters params;
|
||||||
|
|
||||||
|
public StdioServerTransport(ServerParameters params) {
|
||||||
|
this(params, new ObjectMapper());
|
||||||
|
}
|
||||||
|
|
||||||
|
public StdioServerTransport(ServerParameters params, ObjectMapper objectMapper) {
|
||||||
|
|
||||||
|
super(objectMapper);
|
||||||
|
|
||||||
|
Assert.notNull(params, "The params can not be null");
|
||||||
|
Assert.notNull(objectMapper, "The ObjectMapper can not be null");
|
||||||
|
|
||||||
|
this.params = params;
|
||||||
|
|
||||||
|
// Start threads
|
||||||
|
this.inboundScheduler = Schedulers.fromExecutorService(Executors.newSingleThreadExecutor(),
|
||||||
|
"inbound");
|
||||||
|
this.outboundScheduler = Schedulers.fromExecutorService(Executors.newSingleThreadExecutor(),
|
||||||
|
"outbound");
|
||||||
|
this.errorScheduler = Schedulers.fromExecutorService(Executors.newSingleThreadExecutor(),
|
||||||
|
"error");
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void start() {
|
||||||
|
// Prepare command and environment
|
||||||
|
List<String> fullCommand = new ArrayList<>();
|
||||||
|
fullCommand.add(params.getCommand());
|
||||||
|
fullCommand.addAll(params.getArgs());
|
||||||
|
|
||||||
|
ProcessBuilder processBuilder = this.getProcessBuilder();
|
||||||
|
processBuilder.command(fullCommand);
|
||||||
|
processBuilder.environment().putAll(params.getEnv());
|
||||||
|
|
||||||
|
// Start the process
|
||||||
|
try {
|
||||||
|
this.process = processBuilder.start();
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new RuntimeException("Failed to start process with command: " + fullCommand, e);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate process streams
|
||||||
|
if (this.process.getInputStream() == null || process.getOutputStream() == null) {
|
||||||
|
this.process.destroy();
|
||||||
|
throw new RuntimeException("Process input or output stream is null");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Initialize readers and writers
|
||||||
|
this.processErrorReader = this.process.errorReader();
|
||||||
|
this.processReader = this.process.inputReader();
|
||||||
|
this.processWriter = this.process.outputWriter();
|
||||||
|
|
||||||
|
// Start threads
|
||||||
|
this.isRunning = true;
|
||||||
|
startInboundProcessing();
|
||||||
|
startOutboundProcessing();
|
||||||
|
startErrorProcessing();
|
||||||
|
}
|
||||||
|
|
||||||
|
protected ProcessBuilder getProcessBuilder() {
|
||||||
|
return new ProcessBuilder();
|
||||||
|
}
|
||||||
|
|
||||||
|
public void awaitForExit() {
|
||||||
|
try {
|
||||||
|
this.process.waitFor();
|
||||||
|
} catch (InterruptedException e) {
|
||||||
|
throw new RuntimeException("Process interrupted", e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void startErrorProcessing() {
|
||||||
|
this.errorScheduler.schedule(() -> {
|
||||||
|
try {
|
||||||
|
String line;
|
||||||
|
while (isRunning && processErrorReader != null && (line = processErrorReader.readLine()) != null) {
|
||||||
|
try {
|
||||||
|
System.out.println("Received error line: " + line);
|
||||||
|
// TODO: handle errors, etc.
|
||||||
|
this.getErrorSink().tryEmitNext(line);
|
||||||
|
} catch (Exception e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
if (this.isRunning) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
this.isRunning = false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private void startInboundProcessing() {
|
||||||
|
this.inboundScheduler.schedule(() -> {
|
||||||
|
try {
|
||||||
|
String line;
|
||||||
|
while (this.isRunning && this.processReader != null && (line = this.processReader.readLine()) != null) {
|
||||||
|
try {
|
||||||
|
JSONRPCMessage message = deserializeJsonRpcMessage(line);
|
||||||
|
if (!this.getInboundSink().tryEmitNext(message).isSuccess()) {
|
||||||
|
// TODO: Back off, reschedule, give up?
|
||||||
|
throw new RuntimeException("Failed to enqueue message");
|
||||||
|
}
|
||||||
|
} catch (Exception e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} catch (IOException e) {
|
||||||
|
if (isRunning) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
isRunning = false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
private JSONRPCMessage deserializeJsonRpcMessage(String jsonText) throws IOException {
|
||||||
|
|
||||||
|
var map = this.objectMapper.readValue(jsonText, MAP_TYPE_REF);
|
||||||
|
|
||||||
|
// Determine message type based on specific JSON structure
|
||||||
|
if (map.containsKey("method") && map.containsKey("id")) {
|
||||||
|
return this.objectMapper.convertValue(map, JSONRPCRequest.class);
|
||||||
|
} else if (map.containsKey("method") && !map.containsKey("id")) {
|
||||||
|
return this.objectMapper.convertValue(map, JSONRPCNotification.class);
|
||||||
|
} else if (map.containsKey("result") || map.containsKey("error")) {
|
||||||
|
return this.objectMapper.convertValue(map, JSONRPCResponse.class);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new IllegalArgumentException("Cannot deserialize JSONRPCMessage: " + jsonText);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void startOutboundProcessing() {
|
||||||
|
this.getOutboundSink()
|
||||||
|
.asFlux()
|
||||||
|
// this bit is important since writes come from user threads and we
|
||||||
|
// want to ensure that the actual writing happens on a dedicated thread
|
||||||
|
.publishOn(outboundScheduler)
|
||||||
|
.handle((message, s) -> {
|
||||||
|
if (message != null) {
|
||||||
|
try {
|
||||||
|
this.processWriter.write(objectMapper.writeValueAsString(message));
|
||||||
|
this.processWriter.newLine();
|
||||||
|
this.processWriter.flush();
|
||||||
|
s.next(message);
|
||||||
|
} catch (IOException e) {
|
||||||
|
s.error(new RuntimeException(e));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.subscribe();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Mono<Void> closeGracefully() {
|
||||||
|
|
||||||
|
this.isRunning = false;
|
||||||
|
|
||||||
|
return Mono.whenDelayError(
|
||||||
|
Mono.fromRunnable(() -> {
|
||||||
|
try {
|
||||||
|
this.processErrorReader.close();
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}).subscribeOn(errorScheduler),
|
||||||
|
Mono.fromRunnable(() -> {
|
||||||
|
try {
|
||||||
|
this.processReader.close();
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}).subscribeOn(inboundScheduler),
|
||||||
|
Mono.fromRunnable(() -> {
|
||||||
|
try {
|
||||||
|
this.processWriter.close();
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new RuntimeException(e);
|
||||||
|
}
|
||||||
|
}).subscribeOn(outboundScheduler))
|
||||||
|
.then(Mono.whenDelayError(inboundScheduler.disposeGracefully(),
|
||||||
|
outboundScheduler.disposeGracefully(),
|
||||||
|
errorScheduler.disposeGracefully()))
|
||||||
|
.then(Mono.fromRunnable(() -> {
|
||||||
|
if (this.process != null) {
|
||||||
|
var process = this.process.destroyForcibly();
|
||||||
|
if (process.exitValue() != 0) {
|
||||||
|
throw new RuntimeException("Failed to destroy process");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
.then()
|
||||||
|
.subscribeOn(Schedulers.boundedElastic());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,75 @@
|
||||||
|
/*
|
||||||
|
* 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 spring.ai.experimental.mcp.client.util;
|
||||||
|
|
||||||
|
import reactor.util.annotation.Nullable;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Christian Tzolov
|
||||||
|
* @since 1.0.0
|
||||||
|
*/
|
||||||
|
|
||||||
|
public class Assert {
|
||||||
|
/**
|
||||||
|
* Assert that an object is not {@code null}.
|
||||||
|
*
|
||||||
|
* <pre class="code">
|
||||||
|
* Assert.notNull(clazz, "The class must not be null");
|
||||||
|
* </pre>
|
||||||
|
*
|
||||||
|
* @param object the object to check
|
||||||
|
* @param message the exception message to use if the assertion fails
|
||||||
|
* @throws IllegalArgumentException if the object is {@code null}
|
||||||
|
*/
|
||||||
|
public static void notNull(@Nullable Object object, String message) {
|
||||||
|
if (object == null) {
|
||||||
|
throw new IllegalArgumentException(message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Assert that the given String contains valid text content; that is, it must not
|
||||||
|
* be {@code null} and must contain at least one non-whitespace character.
|
||||||
|
* <pre class="code">Assert.hasText(name, "'name' must not be empty");</pre>
|
||||||
|
* @param text the String to check
|
||||||
|
* @param message the exception message to use if the assertion fails
|
||||||
|
* @throws IllegalArgumentException if the text does not contain valid text content
|
||||||
|
* @see StringUtils#hasText
|
||||||
|
*/
|
||||||
|
public static void hasText(@Nullable String text, String message) {
|
||||||
|
if (!hasText(text)) {
|
||||||
|
throw new IllegalArgumentException(message);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check whether the given {@code String} contains actual <em>text</em>.
|
||||||
|
* <p>More specifically, this method returns {@code true} if the
|
||||||
|
* {@code String} is not {@code null}, its length is greater than 0,
|
||||||
|
* and it contains at least one non-whitespace character.
|
||||||
|
* @param str the {@code String} to check (may be {@code null})
|
||||||
|
* @return {@code true} if the {@code String} is not {@code null}, its
|
||||||
|
* length is greater than 0, and it does not contain whitespace only
|
||||||
|
* @see #hasText(CharSequence)
|
||||||
|
* @see #hasLength(String)
|
||||||
|
* @see Character#isWhitespace
|
||||||
|
*/
|
||||||
|
public static boolean hasText(@Nullable String str) {
|
||||||
|
return (str != null && !str.isBlank());
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,119 @@
|
||||||
|
/*
|
||||||
|
* 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 spring.ai.experimental.mcp.spec;
|
||||||
|
|
||||||
|
import java.util.function.Consumer;
|
||||||
|
|
||||||
|
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||||
|
import reactor.core.publisher.Mono;
|
||||||
|
import reactor.core.publisher.Sinks;
|
||||||
|
import spring.ai.experimental.mcp.client.util.Assert;
|
||||||
|
import spring.ai.experimental.mcp.spec.McpSchema.JSONRPCMessage;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Christian Tzolov
|
||||||
|
* @author Dariusz Jędrzejczyk
|
||||||
|
*/
|
||||||
|
public abstract class AbstractMcpTransport implements McpTransport {
|
||||||
|
|
||||||
|
protected final ObjectMapper objectMapper;
|
||||||
|
|
||||||
|
private final Sinks.Many<String> errorSink;
|
||||||
|
private final Sinks.Many<JSONRPCMessage> inboundSink;
|
||||||
|
private final Sinks.Many<JSONRPCMessage> outboundSink;
|
||||||
|
|
||||||
|
private Consumer<JSONRPCMessage> inboundMessageHandler = message -> System.out
|
||||||
|
.println("Received message: " + message);
|
||||||
|
private Consumer<String> errorHandler = error -> System.err.println("Received error: " + error);
|
||||||
|
|
||||||
|
public AbstractMcpTransport() {
|
||||||
|
this(new ObjectMapper());
|
||||||
|
}
|
||||||
|
|
||||||
|
public AbstractMcpTransport(ObjectMapper objectMapper) {
|
||||||
|
|
||||||
|
Assert.notNull(objectMapper, "ObjectMapper must not be null");
|
||||||
|
this.objectMapper = objectMapper;
|
||||||
|
|
||||||
|
// TODO: consider the effects of buffering here -> the inter-process pipes are
|
||||||
|
// independent and the notifications can flood the client/server.
|
||||||
|
// Potentially, the interest in reading could be communicated from one party
|
||||||
|
// to the other so the Blocking IO Threads can pause consuming the stream
|
||||||
|
// buffers when there is no expectation for reading.
|
||||||
|
|
||||||
|
this.errorSink = Sinks.many().unicast().onBackpressureBuffer();
|
||||||
|
this.inboundSink = Sinks.many().unicast().onBackpressureBuffer();
|
||||||
|
this.outboundSink = Sinks.many().unicast().onBackpressureBuffer();
|
||||||
|
|
||||||
|
this.handleIncomingMessages();
|
||||||
|
}
|
||||||
|
|
||||||
|
public ObjectMapper getObjectMapper() {
|
||||||
|
return this.objectMapper;
|
||||||
|
}
|
||||||
|
|
||||||
|
private void handleIncomingMessages() {
|
||||||
|
this.inboundSink.asFlux()
|
||||||
|
.subscribe(message -> this.inboundMessageHandler.accept(message));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void handleIncomingErrors() {
|
||||||
|
this.errorSink.asFlux().subscribe(e -> {
|
||||||
|
this.errorHandler.accept(e);
|
||||||
|
// System.err.println(e); TODO: log the error
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
protected Sinks.Many<JSONRPCMessage> getInboundSink() {
|
||||||
|
return inboundSink;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected Sinks.Many<JSONRPCMessage> getOutboundSink() {
|
||||||
|
return outboundSink;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected Sinks.Many<String> getErrorSink() {
|
||||||
|
return errorSink;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setInboudMessageHandler(Consumer<JSONRPCMessage> inboundMessageHandler) {
|
||||||
|
this.inboundMessageHandler = inboundMessageHandler;
|
||||||
|
}
|
||||||
|
|
||||||
|
public void setInboundErrorHandler(Consumer<String> errorHandler) {
|
||||||
|
this.errorHandler = errorHandler;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Start processing incoming messages
|
||||||
|
public void start() {
|
||||||
|
this.handleIncomingErrors();
|
||||||
|
this.handleIncomingMessages();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Mono<Void> sendMessage(JSONRPCMessage message) {
|
||||||
|
if (this.outboundSink.tryEmitNext(message).isSuccess()) {
|
||||||
|
// TODO: essentially we could reschedule ourselves in some time and make
|
||||||
|
// another attempt with the already read data but pause reading until
|
||||||
|
// success
|
||||||
|
// In this approach we delegate the retry and the backpressure onto the
|
||||||
|
// caller. This might be enough for most cases.
|
||||||
|
return Mono.empty();
|
||||||
|
} else {
|
||||||
|
return Mono.error(new RuntimeException("Failed to enqueue message"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue