addozhang/spring-rest-to-mcp

An OpenRewrite recipe collection that automatically converts Spring Web REST APIs to Spring AI Model Context Protocol (MCP) server tools.
## 📋 Introduction
This project provides a set of OpenRewrite recipes that help you migrate traditional Spring Web REST APIs to Spring AI's Model Context Protocol (MCP) server tools. The transformation includes:
1. 🔄 Converting Spring Web annotations to Spring AI MCP @Tool annotations
2. 🔧 Adding necessary MCP configuration and components
3. 📦 Updating Maven dependencies to include Spring AI MCP server components
The recipes automatically extract documentation from your existing REST controllers to create properly documented MCP tools, making your APIs accessible to AI agents through the Model Context Protocol.
For more details about Spring AI's implementation of MCP, see the Spring AI MCP documentation.
## 🛠️ How to Build and Install
### Prerequisites
Java 17 or higher
Maven 3.6+
### Prerequisites for Target REST API Projects
To successfully migrate your Spring Web REST API to MCP, your project should:
Use Spring Boot 3.2+ (3.2.0 or newer)
Use Spring Web MVC for REST controllers
Use Maven build tool
The recipe adds Spring AI MCP dependencies (version 1.0.0-SNAPSHOT or newer) to your project automatically.
### Build Steps
1. Clone this repository:
bash
git clone https://github.com/yourusername/web-to-mcp.git
cd web-to-mcp
2. Build the project:
bash
mvn clean install
This will compile the code and install the artifact to your local Maven repository.
## 🔥 How to Use
To apply the recipes to your Spring Web project, run the following Maven command:
bash
mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
-Drewrite.activeRecipes=RewriteWebToMCP \
-Drewrite.recipeArtifactCoordinates=com.atbug.rewrite:web-to-mcp:1.0-SNAPSHOT \
-Drewrite.exportDatatables=true
Important: This command needs to be executed twice:
1. First execution will update your pom.xml to add necessary repositories and dependencies
2. Second execution will perform the actual code conversion of your Spring Web controllers to MCP tools
## ✨ Features
The recipe performs several transformations that are organized into three main components:
### 1. POM Updates (UpdatePom)
Adds Spring Snapshots repository (https://repo.spring.io/snapshot)
Adds Central Portal Snapshots repository (https://central.sonatype.com/repository/maven-snapshots/)
Adds Spring AI MCP server WebMVC dependency (spring-ai-starter-mcp-server-webmvc)
### 2. Code Transformations
AddToolAnnotationToMappingMethod: Automatically converts Spring Web controller methods to MCP tools
Adds @Tool annotations to methods with Spring Web mapping annotations (@GetMapping, @PostMapping, etc.)
Extracts method descriptions from JavaDoc comments to populate the description attribute
Adds @ToolParam annotations to method parameters, preserving their descriptions from JavaDoc
AddToolCallbackProviderBean: Creates or updates a bean to register MCP tools
Identifies Spring Boot application entry point class
Creates a ToolCallbackProvider bean to register all controllers with @Tool annotations
Intelligently updates existing provider beans if they already exist
AddSpringAIMcpProperties: Configures MCP server properties