Spring Ai MCP

🚀 Java & Spring MCP

A library for integrating Java and Spring frameworks with the Model Context Protocol (MCP). The MCP allows language models to interact with external tools and data sources.

⚠️ Important Note

This project has graduated! Please visit the new repository for the latest version.

🚀 Quick Start

This library integrates Java and Spring frameworks with the Model Context Protocol (MCP), enabling language models to interact with external tools and data sources. It offers a Java SDK and Spring AI integration modules.

📚 Documentation

• Java MCP SDK Documentation
  • Reference Documentation

✨ Features

Project Structure

Core MCP Modules

• mcp: Provides a Java implementation of the MCP protocol stack, including core protocols and tools.

Transport Layer Modules

• mcp-http-client-sse: An HTTP-based Server-Sent Events (SSE) client implementation.
• mcp-servlet-sse: A Servlet-based SSE server implementation.
• mcp-webmvc: A Spring Web MVC integration module for creating MCP servers.
• mcp-webflux: A Spring WebFlux integration module for creating MCP servers.

Spring AI Integration Modules

• spring-ai-mcp: An MCP integration module for Spring AI.

📦 Installation

To add this project to your Maven project, add the following dependencies to your pom.xml:

<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>mcp-core</artifactId>
    <version>{latest_version}</version>
</dependency>

<!-- If you need the HTTP client -->
<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>mcp-http-client-sse</artifactId>
    <version>{latest_version}</version>
</dependency>

<!-- If you need the Servlet server -->
<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>mcp-servlet-sse</artifactId>
    <version>{latest_version}</version>
</dependency>

<!-- If you use Spring Web MVC -->
<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>mcp-webmvc</artifactId>
    <version>{latest_version}</version>
</dependency>

<!-- If you use Spring WebFlux -->
<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>mcp-webflux</artifactId>
    <version>{latest_version}</version>
</dependency>

To configure the Maven repository, add the following to your settings.xml:

<mirror>
    <id>habuma-repo</id>
    <url>https://repo.habuma.dev/maven-snapshot/</url>
    <mirrorOf>*</mirrorOf>
</mirror>

For more details, refer to Dependency Management.

💻 Usage Examples

Basic Usage

In the spring-ai-examples/model-context-protocol repository, you can find the following MCP examples:

• SQLite Simple: Demonstrates how an LLM can integrate with an SQLite database.
• SQLite Chatbot: Creates an interactive chatbot that can interact with an SQLite database.
• Filesystem: Allows an LLM to interact with files and folders in the local file system.
• Brave: Implements natural language interaction with Brave Search, supporting internet search functionality.
• Theme Park API Example: Demonstrates how to use Spring AI to create MCP servers and clients and integrate the Theme Park API tool.
• Http SSE Client + WebMvc Server: Demonstrates how to create and use MCP WebMvc servers and HttpClient clients with different functionalities.
• WebFlux SSE Client + WebFlux Server: Demonstrates how to create and use MCP WebFlux servers and clients with different functionalities.
• HttpClient SSE Client + Servlet Server: Demonstrates how to create and use MCP Servlet servers and HttpClient clients with different functionalities.

🔧 Technical Details

Building from Source

mvn clean install

Running Tests

mvn test

🤝 Contribution

This is an experimental Spring project. Contributions are welcome! Please follow these steps to submit your code:

1. Fork the repository.
2. Create a feature branch.
3. Submit a pull request.

⚠️ Important Note

This project is still in its early stages and may be unstable. Please read the documentation carefully and test before use.