updated the readme

README.md

@@ -1,13 +1,161 @@
----
-title: Code Review Agent
-emoji: 🏆
-colorFrom: yellow
-colorTo: green
-sdk: gradio
-sdk_version: 5.33.0
-app_file: app.py
-pinned: false
-short_description: An AI-powered code review agent that analyzes repositories f
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# Code Review Agent
+
+[![agent-demo-track](https://img.shields.io/badge/Gradio-agent--demo--track-orange)](https://huggingface.co/Agents-MCP-Hackathon)
+[![MCP-Server](https://img.shields.io/badge/MCP-Server-blue)](https://www.gradio.app/guides/building-mcp-server-with-gradio)
+
+A professional-grade code review agent that leverages AI to provide comprehensive code analysis and actionable recommendations. Built for the Gradio MCP Hackathon, this tool helps developers improve code quality through automated reviews powered by advanced AI models.
+
+![Gradio MCP Hackathon](https://cdn-thumbnails.huggingface.co/social-thumbnails/spaces/alvi15tooba/hackathon-gradio-app.png)
+
+## 🚀 Features
+
+- **Multi-Language Support**: Analyzes code in 15+ programming languages including Python, JavaScript, TypeScript, Java, C++, and more
+- **Enterprise-Grade UI**: Professional Gradio interface with modern design and intuitive workflow
+- **Advanced Analysis**: Comprehensive insights on security vulnerabilities, performance bottlenecks, and code quality issues
+- **GitHub Integration**: Support for both public and private GitHub repositories with secure token authentication
+- **MCP Server**: Functions as a Model Context Protocol (MCP) server, allowing LLMs to use this tool for code review operations
+- **Professional Reporting**: Detailed reports with actionable recommendations organized by priority
+- **Customizable Reviews**: Select specific languages to focus the review on parts of your codebase that matter most
+
+## 🏗️ Architecture
+
+The system follows a robust 4-layer architecture designed for extensibility and maintainability:
+
+1. **Presentation Layer**: Gradio-based UI with professional dashboard and intuitive controls
+2. **Application Layer**: Core business logic and review engine with modular components
+3. **Service Layer**: External integrations and analysis services with clean interfaces
+4. **MCP Layer**: Implements the Model Context Protocol (MCP) server functionality, allowing LLMs to use this tool for code review operations through standardized communication
+
+## 📋 Requirements
+
+- Python 3.8+
+- Git
+- Internet connection for AI model access
+- GitHub token (optional, for private repositories)
+
+## 🔧 Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/cypher125/code-review-agent.git
+cd code-review-agent
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Set up environment variables (optional)
+cp sample.env .env
+# Edit .env with your configuration
+```
+
+## 🚀 Usage
+
+```bash
+python src/main.py
+```
+
+Then open your browser to http://localhost:7860 to access the Code Review Agent.
+
+### Analyzing a Repository
+
+1. Enter the GitHub repository URL in the input field
+2. Optionally enter your GitHub token for private repositories
+3. Select the programming languages to focus the review on
+4. Click "Submit" to start the analysis
+5. View the comprehensive report with actionable recommendations
+
+## 🐳 Docker Deployment
+
+```bash
+# Build and run with Docker Compose
+docker-compose up -d
+```
+
+Access the application at http://localhost:7860
+
+## 🔌 MCP Server Functionality
+
+This application functions as a Model Context Protocol (MCP) server, allowing Large Language Models (LLMs) to use it as a tool for code review operations:
+
+- **MCP Integration**: Exposes code review capabilities through standardized MCP endpoints
+- **LLM Tool Usage**: Can be called by LLMs like Claude, GPT-4, and others that support the MCP protocol
+- **Tool Operations**: Provides repository analysis, code review, and report generation as MCP operations
+- **Structured Responses**: Returns analysis results in structured formats compatible with LLM processing
+
+To use this as an MCP server with your LLM:
+
+1. Deploy the application using the instructions above
+2. Configure your MCP client to connect to the server endpoint
+3. The LLM can then use the code review capabilities through MCP tool calls
+
+## 🧪 Testing
+
+```bash
+# Run the test suite
+python -m pytest tests/
+```
+
+## 📁 Project Structure
+
+```
+├── .env                    # Environment variables configuration
+├── .gitignore              # Git ignore file
+├── DEPLOYMENT_GUIDE.md     # Guide for deploying to Hugging Face and Modal
+├── Dockerfile              # Docker configuration
+├── LICENSE                 # MIT License file
+├── README.md               # Project documentation
+├── app.py                  # Entry point for Hugging Face Spaces
+├── docker-compose.yml      # Docker Compose configuration
+├── modal_deploy.py         # Modal deployment configuration
+├── prompt.txt              # AI prompt templates
+├── requirements.txt        # Python dependencies
+├── run.py                  # Alternative entry script
+├── sample.env              # Sample environment variables
+├── setup.py                # Package setup configuration
+├── src/                    # Source code directory
+│   ├── __init__.py         # Package initialization
+│   ├── core/               # Core application logic
+│   │   ├── __init__.py
+│   │   ├── agent_manager.py    # Agent orchestration
+│   │   └── language_detector.py # Language detection
+│   ├── main.py             # Main application entry point
+│   ├── mcp/                # MCP server implementation
+│   │   ├── __init__.py
+│   │   └── ai_review.py    # AI review integration
+│   ├── services/           # Service layer components
+│   │   ├── __init__.py
+│   │   ├── code_analyzer.py       # Code analysis
+│   │   ├── performance_analyzer.py # Performance analysis
+│   │   ├── report_generator.py     # Report generation
+│   │   ├── repository_service.py   # Repository operations
+│   │   └── security_scanner.py     # Security scanning
+│   └── ui/                 # User interface components
+│       ├── __init__.py
+│       ├── components/     # UI components
+│       ├── gradio_app.py   # Gradio application
+│       └── styles/         # UI styling
+└── tests/                  # Test directory
+    ├── test_agent_manager.py
+    ├── test_ai_review.py
+    ├── test_code_analyzer.py
+    ├── test_language_detector.py
+    ├── test_performance_analyzer.py
+    ├── test_report_generator.py
+    ├── test_repository_service.py
+    └── test_security_scanner.py
+```
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some 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 [LICENSE](LICENSE) file for details.