Java & Spring MCP

Java SDK for the Model Context Protocol (MCP), providing seamless integration between Java and Spring applications and MCP-compliant AI resources and tools.

Overview

Experimental project that provides Java and Spring Framework integration for the Model Context Protocol. It enables Java applications to interact with AI models and tools through a standardized interface, supporting both synchronous and asynchronous communication patterns.

Modules

The project consists of two main modules:

mcp

The core module provides a Java implementation of the Model Context Protocol specification. It includes:

• Synchronous and asynchronous client implementations
• Standard MCP operations support (tool discovery, resource management, prompt handling). Support for request and notificaiotn handling.
• Stdio and SSE transport implementations.
• Find more.

spring-ai-mcp

The Spring integration module provides Spring-specific functionality:

• Integration with Spring AI's function calling system
• Spring-friendly abstractions for MCP clients
• Auto-configurations (WIP)

Requirements

• Java 17 or later
• Maven 3.6 or later
• Spring AI 1.0.0-M4 or later

Installation

Add the following dependencies to your Maven project:

<!-- For core MCP functionality -->
<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>mcp</artifactId>
    <version>0.2.0-SNAPSHOT</version>
</dependency>

<!-- For Spring AI integration -->
<dependency>
    <groupId>org.springframework.experimental</groupId>
    <artifactId>spring-ai-mcp</artifactId>
    <version>0.2.0-SNAPSHOT</version>
</dependency>

Example Demos

Explore these MCP examples in the spring-ai-examples/model-context-protocol repository:

• SQLite Simple - Demonstrates LLM integration with a database
• SQLite Chatbot - Interactive chatbot with SQLite database interaction
• Filesystem - Enables LLM interaction with local filesystem folders and files
• Brave - Enables natural language interactions with Brave Search, allowing you to perform internet searches.

Documentation

• Core Module Documentation
• Spring Integration Documentation
• UML Class Diagrams

Development

Building from Source

mvn clean install

Running Tests

mvn test

Project Information

• Group ID: org.springframework.experimental
• Version: 0.2.0-SNAPSHOT
• Java Version: 17
• Spring AI Version: 1.0.0-M4

Contributing

This is an experimental Spring project. Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch
3. Submit a Pull Request

Team

• Christian Tzolov
• Dariusz Jędrzejczyk

Links

• GitHub Repository
• Issue Tracker
• CI/CD

License

This project is licensed under the Apache License 2.0.

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.