Spring Rest To MCP

🚀 Spring Web Conversion Tool

This project offers a tool to transform traditional REST APIs into Spring AI MCP (Machine Companion Protocol) servers. With simple annotation additions and configuration modifications, your APIs can instantly gain modern AI interaction capabilities.

🚀 Quick Start

Transformation Process

Step 1: Update the POM file

mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
  -Drewrite.activeRecipes=org.spring.rewrite.McpConversionRecipe \
  -Drewrite.recipeArtifactCoordinates=com.example:spring-web-conversion-tool:1.0.0 \
  -Drewrite.exportDatatables=true

Step 2: Apply annotation conversion

mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
  -Drewrite.activeRecipes=org.spring.rewrite.McpConversionRecipe \
  -Drewrite.recipeArtifactCoordinates=com.example:spring-web-conversion-tool:1.0.0 \
  -Drewrite.exportDatatables=true

Step 3: Verify the transformation results

• Check if the @Tool and @ToolParam annotations are correctly added to the Controller classes.
• See if the tool registration bean is automatically generated in the main application class.
• Confirm if the MCP server configuration is newly added to application.properties or application.yml.

✨ Features

• Automatic annotation processing: Automatically add the necessary @Tool and @ToolParam annotations to REST methods while maintaining existing functionality.
• Automatic configuration generation: Automatically add all the configurations required by the MCP server to application.properties or application.yml.
• Tool registration: Automatically generate the tool registration bean without manually implementing the tool discovery logic.

📚 Documentation

Use Cases

1. Legacy system upgrade: Quickly transform legacy REST APIs into new-generation interfaces that support AI interaction.
2. API modernization: Add AI interaction capabilities to existing Spring Boot services.
3. Hybrid architecture: Maintain support for both traditional and modern clients simultaneously.

💻 Usage Examples

Example Project

Project Structure

git clone https://github.com/example/spring-boot-rest-api.git
cd spring-boot-rest-api

Core Code Examples

Controller Class

@Tool(description = "Get user information")
public User getUserById(@ToolParam(description = "User ID") @PathVariable Long id) {
    // Implementation logic
}

Configuration File

spring.ai.mcp.server.name=my-rest-api-mcp-server
spring.ai.mcp.server.sse-message-endpoint=/mcp/messages
spring.ai.mcp.server.type=SYNC
spring.ai.mcp.server.version=1.0.0

Tool Registration Example

@Bean
ToolCallbackProvider toolCallbackProvider(MyController myController) {
    return MethodToolCallbackProvider.builder()
            .toolObjects(myController)
            .build();
}

Demonstration Process

1. Clone the example project:

   git clone https://github.com/example/spring-boot-rest-api.git
   cd spring-boot-rest-api
   

2. Execute the Maven command to complete the transformation:

   mvn org.openrewrite.maven:rewrite-maven-plugin:6.4.0:run \
     -Drewrite.activeRecipes=org.spring.rewrite.McpConversionRecipe \
     -Drewrite.recipeArtifactCoordinates=com.example:spring-web-conversion-tool:1.0.0 \
     -Drewrite.exportDatatables=true
   

3. Start the application:

   mvn spring-boot:run
   

4. Use the MCP Inspector for verification:

   git clone https://github.com/protocol/mcp-inspector.git
   cd mcp-inspector
   npm install && npm run dev
   

Configuration Example

Client Configuration

{
  "servers": [
    {
      "url": "http://localhost:8080",
      "name": "my-rest-api-mcp-server"
    }
  ]
}

📄 License

This project uses the MIT License, allowing free modification and use.

💪 Contribution Guidelines

Welcome to submit PRs to fix issues or improve functionality. Please fork the repository and develop on your own branch.

📞 Contact Information

If you have any questions, please contact: contact@example.com

Spring Web Conversion Tool

A bridge to transform traditional REST APIs into modern AI interaction services