Content
# MCP Agents Cloud
MCP Agents Cloud is a platform for managing MCP servers and agents.
## Features
- User management (registration, login, password reset)
- MCP server management (add, edit, delete, view)
- Agent management (create, edit, delete, view)
- Agent SDK (Python package and HTTP API)
- Agent chat interaction (streaming output)
- SDK key management
## Tech Stack
### Frontend
- Vue.js
- Element UI
- Axios
- Vue Router
- Vuex
### Backend
- Python
- FastAPI
- SQLAlchemy
- JWT
- openai-agent framework
### Database
- MySQL 8.0
## Quick Start
### Install Dependencies
The project depends on a MySQL database, which can be quickly installed via Docker:
```bash
# Enter the docker directory
cd docker
# Ensure the data directory exists
sudo mkdir -p /appdata/share/agents-mcp-cloud/mysql/data
sudo chown -R $USER:$USER /appdata/share/agents-mcp-cloud/mysql/data
# Start the MySQL service
docker-compose up -d mysql
```
The database will start on port 63307. For detailed instructions, please refer to the [Docker Dependency Documentation](docker/README.md).
### Backend Setup
1. Enter the backend directory:
```bash
cd backend
```
2. Create a virtual environment:
```bash
python -m venv venv
```
3. Activate the virtual environment:
```bash
# Windows
venv\Scripts\activate
# Linux/Mac
source venv/bin/activate
```
4. Install dependencies:
```bash
pip install -r requirements.txt
```
5. Configure the system:
```bash
# Copy the corresponding configuration file based on the environment
cp config.yml.example config-dev.yml
# Then edit the configuration file
```
6. Run the application:
```bash
# Set the environment (default is dev)
export ENV=dev # or test, prod
# Or directly specify the absolute path of the configuration file
export CONFIG_FILE="$(pwd)/config-dev.yml"
# Run the service
cd backend # Ensure you are in the backend directory
uvicorn main:app --reload
```
### Frontend Setup
1. Enter the frontend directory:
```bash
cd frontend
```
2. Install dependencies:
```bash
npm install
```
3. Run the development server:
```bash
npm run serve
```
4. Build the production version:
```bash
npm run build
```
## Configuration Description
The project uses environment-based YAML configuration files:
- `config-dev.yml`: Development environment configuration
- `config-test.yml`: Testing environment configuration
- `config-prod.yml`: Production environment configuration
Configuration files should be placed in the backend directory, and you can specify the configuration in two ways:
```bash
# 1. Specify the environment through environment variables, the system will look for backend/config-{ENV}.yml
export ENV=dev # or test, prod
# 2. Directly specify the absolute path of the configuration file (recommended)
export CONFIG_FILE="/full/path/to/config-file/config-dev.yml"
```
Main configuration items include:
- `app`: Basic information such as application name and version
- `api`: API path prefix and documentation URL
- `server`: Server host and port settings
- `security`: Security settings (keys, token expiration time)
- `cors`: Cross-origin settings
- `database`: Database connection URL and connection pool settings
- `openai`: OpenAI API key and model settings
- `email`: Email sending settings
- `smtp`: SMTP server configuration
For detailed configuration examples, please refer to the `config.yml.example` file.
## API Documentation
After starting the backend server, you can access the API documentation at the following address:
```
http://localhost:8000/api/v1/docs
```
## Project Structure
```
agents-mcp-cloud/
├── backend/ # Backend code
│ ├── app/ # Application code
│ │ ├── api/ # API routes
│ │ ├── core/ # Core functionalities
│ │ ├── db/ # Database utilities
│ │ ├── models/ # Data models
│ │ ├── schemas/ # Pydantic schemas
│ │ ├── utils/ # Utility functions
│ │ └── services/ # Business services
│ ├── config-dev.yml # Development environment configuration
│ ├── config-test.yml # Testing environment configuration
│ ├── config-prod.yml # Production environment configuration
│ ├── main.py # Main application entry
│ └── requirements.txt # Dependency list
├── docker/ # Docker dependencies
│ ├── docker-compose.yml # Docker compose file
│ └── mysql/ # MySQL related configurations
├── frontend/ # Frontend code
│ ├── public/ # Static resources
│ ├── src/ # Source code
│ │ ├── assets/ # Asset files
│ │ ├── components/ # Vue components
│ │ ├── router/ # Router configuration
│ │ ├── store/ # Vuex store
│ │ ├── views/ # Page views
│ │ └── api/ # API client
│ └── package.json # Dependency list
└── scripts/ # Script files
```
## License
[MIT](LICENSE)
Connection Info
You Might Also Like
MarkItDown MCP
Converting files and office documents to Markdown.
semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
opik
Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic...
apisix
The Cloud-Native API Gateway and AI Gateway
claude-flow
🌊 The leading agent orchestration platform for Claude. Deploy intelligent...
convex-backend
The open-source reactive database for app developers