# MCP Learning Project

A comprehensive learning platform for Model Context Protocol (MCP) development. This project is designed to help you learn MCP development from basics to advanced concepts through hands-on experience.

## 🚀 Quick Start

### Prerequisites
- Python 3.8 or higher
- Git
- VS Code or Cursor (recommended)

### Installation

1. **Clone the repository** (if using Git):
   ```bash
   git clone <your-repo-url>
   cd mcp-learning-project
   ```

2. **Install dependencies**:
   ```bash
   pip install -r requirements.txt
   ```

3. **Set up environment**:
   ```bash
   cp .env.example .env
   # Edit .env with your configuration
   ```

4. **Run the basic server**:
   ```bash
   python src/main.py
   ```

## 📚 Learning Path

### Phase 1: Foundation (Start Here!)
- [x] **Basic MCP Server** - Learn fundamental MCP concepts
- [x] **Text Processing Module** - Handle text manipulation tasks
- [x] **File Operations Module** - Work with files and directories

### Phase 2: Intermediate
- [ ] **Database Integration** - Connect with databases
- [ ] **API Integration** - Work with external APIs
- [ ] **Configuration Management** - Handle app settings

### Phase 3: Advanced
- [ ] **Machine Learning** - Integrate ML models
- [ ] **Web Interface** - Create web-based tools
- [ ] **Monitoring & Analytics** - Track performance

## 🏗️ Project Structure

```
mcp-learning-project/
├── src/                    # Source code
│   ├── core/              # Core MCP server
│   ├── modules/           # Individual modules
│   ├── shared/            # Shared utilities
│   └── web/               # Web interface
├── tests/                 # Test files
├── docs/                  # Generated documentation
├── config/                # Configuration files
├── scripts/               # Utility scripts
├── examples/              # Example usage
└── project-docs/          # Project documentation
```

## 🛠️ Available Modules

### Text Processing Module
- **Word Count**: Count words in text
- **Text Summarization**: Create summaries
- **Language Detection**: Detect text language
- **Sentiment Analysis**: Analyze text sentiment

### File Operations Module
- **File Reading**: Read file contents
- **File Writing**: Write data to files
- **Directory Operations**: List, create, delete directories
- **File Format Conversion**: Convert between formats

## 🧪 Testing

Run tests to ensure everything works:
```bash
python -m pytest tests/
```

## 📖 Documentation

- [Project Overview](project-docs/overview.md)
- [Requirements & Features](project-docs/requirements.md)
- [Technical Specifications](project-docs/tech-specs.md)
- [User Flow & Structure](project-docs/user-structure.md)

## 🎯 Your First Steps

1. **Explore the code**: Look at `src/modules/text_processing/` to see how modules work
2. **Run examples**: Try the examples in the `examples/` folder
3. **Add your own module**: Follow the template in `src/modules/base/`
4. **Test your changes**: Use the testing framework

## 🤝 Contributing

This is a learning project! Feel free to:
- Add new modules
- Improve existing code
- Fix bugs
- Add documentation
- Share your learning experiences

## 📝 License

This project is for educational purposes. Feel free to use and modify as needed.

## 🆘 Getting Help

- Check the [documentation](project-docs/)
- Look at the [examples](examples/)
- Review the [test files](tests/) for usage examples

---

**Happy Learning! 🎉**

Start with the basic modules and gradually add more complex features as you learn. Each module is designed to teach you different aspects of MCP development.