Enhance project structure and documentation

- Updated code structure in documentation for clarity.
- Added example configuration file for AutoGen-MCP-Server.
- Created detailed logs directory documentation.
- Expanded development requirements with additional tools.
- Updated core requirements with new dependencies.
- Added module docstrings for better code understanding.
- Introduced a web UI template for configuration management.
- Implemented integration and unit test structure.
This commit is contained in:
2025-07-06 23:27:07 +02:00
parent a774772fe1
commit c8cdb3cc28
16 changed files with 349 additions and 10 deletions

View File

@@ -64,15 +64,30 @@ This project implements a hierarchical MCP (Model Context Protocol) server syste
### Code Structure
```
src/
├── mcp_server/ # Main MCP server implementation
├── agents/ # AutoGen agent implementations
│ ├── moderator.py # Moderator agent
│ ├── base_agent.py # Base class for specialized agents
│ └── specialized/ # Specialized agent implementations
├── config/ # Configuration management
├── utils/ # Utility functions
└── main.py # Entry point
├── src/ # Source code
├── mcp_server/ # Main MCP server implementation
├── agents/ # AutoGen agent implementations
│ ├── moderator.py # Moderator agent
│ ├── base_agent.py # Base class for specialized agents
│ └── specialized/ # Specialized agent implementations
├── config/ # Configuration management
├── utils/ # Utility functions
│ ├── web_ui/ # Web UI for configuration management
│ │ ├── api/ # REST API endpoints
│ │ ├── static/ # CSS, JS, images
│ │ └── templates/ # HTML templates
│ └── main.py # Entry point
├── config/ # Configuration files
│ ├── example-config.yml # Example configuration
│ └── config.yml # Actual configuration (not in git)
├── tests/ # Test files
│ ├── unit/ # Unit tests
│ └── integration/ # Integration tests
├── logs/ # Log files (not in git)
├── docs/ # Documentation
├── requirements.txt # Python dependencies
├── requirements-dev.txt # Development dependencies
└── .venv/ # Virtual environment
```
### Configuration Format
@@ -96,12 +111,15 @@ routing_rules:
```
### Key Technologies
- **Python 3.12+**
- **Python 3.12+** (3.13+ preferred when available)
- **AutoGen**: Multi-agent framework
- **MCP SDK**: Model Context Protocol implementation
- **FastAPI**: Modern web framework for Web UI
- **Pydantic**: Configuration validation
- **PyYAML**: Configuration parsing
- **AsyncIO**: Asynchronous operations
- **SQLAlchemy**: Database ORM (for configuration storage)
- **Uvicorn**: ASGI server
### Development Phases
1. **Phase 1**: Basic MCP server + single specialized agent