spartacus-mcp-server/examples/README.md

MCP server for SAP Spartacus development tools - Generate components, services, and models following Spartacus conventions

# Spartacus MCP Framework - Examples

This directory contains comprehensive examples for all tools available in the Spartacus MCP framework. Each example includes the tool call structure, parameters, and expected outputs.

## 📁 Directory Structure

```
examples/
├── component-generation/     # Component creation examples
├── service-management/       # Service & state management examples
├── project-analysis/         # Project analysis examples
├── cms-content/             # CMS & content management examples
├── testing-quality/         # Testing & quality examples
├── migration/               # Migration tools examples
├── styling-theming/         # Styling & theming examples
├── devops-deployment/       # DevOps & deployment examples
└── configs/                 # Configuration examples
```

## 🚀 Quick Start

1. **Choose a tool category** from the directories above
2. **Copy the example JSON** for the tool you want to use
3. **Modify the parameters** to match your project needs
4. **Execute the tool** through your MCP client

## 📋 Tool Categories Overview

### 1. Component Generation (15+ tools)
- Smart component creation with variants
- B2B/B2C component generation
- Component refactoring and optimization

### 2. Service & State Management (10+ tools)
- NgRx store setup and management
- API client generation
- Service layer creation

### 3. Project Analysis (8+ tools)
- Structure analysis and recommendations
- Dependency analysis and optimization
- Performance analysis and improvements

### 4. CMS & Content Management (6+ tools)
- CMS component creation
- Content slot management
- Personalization setup

### 5. Testing & Quality (8+ tools)
- Unit test generation
- E2E test creation
- Code quality analysis

### 6. Migration Tools (6+ tools)
- Spartacus version migration
- Angular version migration
- Breaking changes detection

### 7. Styling & Theming (8+ tools)
- Theme generation
- CSS variables management
- Design tokens conversion

### 8. DevOps & Deployment (10+ tools)
- Build optimization
- CI/CD pipeline generation
- Docker configuration

## 💡 Usage Tips

- **Start with project analysis** to understand your current setup
- **Use component generation** for consistent component creation
- **Apply styling tools** for theme customization
- **Implement testing tools** for quality assurance
- **Use migration tools** for version upgrades
- **Apply DevOps tools** for deployment automation

## 🔧 Configuration

See the `configs/` directory for:
- MCP server settings
- Tool configurations
- Environment variables
- Custom templates

## 📚 Documentation

For detailed documentation, see the main [README.md](../README.md) file.