mhadiahmed/SpringBoostProject

🚀 Spring Boost

The Laravel Boost equivalent for Spring Boot developers - An MCP (Model Context Protocol) server that accelerates AI-assisted Spring Boot development by providing essential context and specialized tools that AI needs to generate high-quality, framework-specific code.

✨ Features

• 🔧 15+ MCP Tools - Specialized tools for Spring Boot development
• 🧠 AI Guidelines - Composable AI guidelines for the Spring Boot ecosystem
• 📚 Documentation API - Semantic search across Spring Boot documentation
• 🗄️ Database Integration - Direct database interaction and schema inspection
• 🎯 Application Context - Deep Spring application inspection capabilities
• ⚡ Performance Optimized - Lightning-fast responses with intelligent caching
• 🐳 Docker Ready - Containerized deployment support
• 🔒 Security First - Sandboxed execution with configurable permissions

🚀 Quick Start

Option 1: One-Line Install (Recommended)

curl -sSL https://install.springboost.com | bash

Option 2: Maven Dependency

Add to your pom.xml:

<dependency>
    <groupId>com.springboost</groupId>
    <artifactId>spring-boost</artifactId>
    <version>1.0.0</version>
</dependency>

Option 3: Gradle Dependency

Add to your build.gradle:

implementation 'com.springboost:spring-boost:1.0.0'

Option 4: Docker

docker run -p 8080:8080 -p 28080:28080 mhadiahmed/springboostproject:latest

🛠️ Available MCP Tools

🎯 Use Cases

🤖 AI-Assisted Development

Connect Spring Boost to your favorite AI coding assistant (Cursor, Claude, etc.) to get:

• Contextual Code Generation - AI understands your Spring Boot application structure
• Database-Aware Suggestions - AI knows your schema and can generate proper queries
• Configuration Help - AI can read and suggest configuration improvements
• Debugging Assistance - AI can analyze logs and suggest fixes

🔍 Application Inspection

• Understand complex Spring Boot applications quickly
• Inspect bean dependencies and configurations
• Analyze database schemas and relationships
• Monitor application health and performance

🧪 Development Productivity

• Execute code snippets in Spring context (like Laravel Tinker)
• Test API endpoints directly
• Query databases safely
• Access comprehensive documentation instantly

📋 Configuration

Create application.yml in your Spring Boot project:

spring-boost:
  mcp:
    enabled: true
    port: 28080
    host: localhost
    tools:
      database-access: true
      code-execution: false  # Enable with caution
  documentation:
    enabled: true
    embeddings-provider: openai  # or 'mock' for development
    cache-size: 1000
  security:
    sandbox:
      enabled: true
      allowed-packages: ["com.example"]

🔌 AI Client Setup

Cursor IDE

Add to your .cursorrules or workspace settings:

{
  "mcp": {
    "servers": {
      "spring-boost": {
        "command": "java",
        "args": ["-jar", "spring-boost.jar"],
        "transport": "websocket",
        "url": "ws://localhost:28080"
      }
    }
  }
}

Claude Desktop

Add to your MCP configuration:

{
  "mcpServers": {
    "spring-boost": {
      "command": "spring-boost",
      "transport": {
        "type": "websocket",
        "url": "ws://localhost:28080"
      }
    }
  }
}

🏗️ Development

Prerequisites

• Java 17 or higher
• Maven 3.6+ or Gradle 7+
• Git

Building from Source

# Clone the repository
git clone https://github.com/mhadiahmed/SpringBoostProject.git
cd SpringBoostProject

# Build with Maven
./mvnw clean package

# Or build with Gradle
./gradlew build

# Run tests
./mvnw test

# Run the application
./mvnw spring-boot:run

Running Tests

# Fast tests only (recommended for development)
./mvnw test

# Include integration tests
./mvnw test -Dtest="**/*IntegrationTest"

# All tests including performance benchmarks
./mvnw verify

🐳 Docker Development

# Build image
docker build -t springboostproject .

# Run with Docker Compose
docker-compose up -d

# View logs
docker-compose logs -f spring-boost

📖 Documentation

• - Detailed installation instructions
• - Complete tool documentation
• - Configuration options
• - AI-specific guidelines
• - Common issues and solutions

🔧 Development Roadmap

• Phase 1: Core infrastructure and MCP server
• Phase 2: Database and web tools
• Phase 3: Advanced tools and code execution
• Phase 4: AI guidelines system
• Phase 5: Documentation API with semantic search
• Phase 6: Integration testing and optimization
• Phase 7: Distribution and packaging

🤝 Contributing

We welcome contributions! Please see our for details.

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the file for details.

🙏 Acknowledgments

• Inspired by Laravel Boost - bringing similar productivity to Spring Boot
• Built on the Model Context Protocol specification
• Spring Boot team for the amazing framework

🔗 Links

• GitHub: https://github.com/mhadiahmed/SpringBoostProject
• Issues: https://github.com/mhadiahmed/SpringBoostProject/issues
• Discussions: https://github.com/mhadiahmed/SpringBoostProject/discussions
• Documentation: Available in the docs/ directory

🌟 Star History

Made with ❤️ for the Spring Boot community