Aapanel

🚀 aaPanel MCP Interface

The aaPanel MCP Interface provides a set of APIs to manage various aspects of the aaPanel system, including system information, website management, database management, Docker container and image management, and email management.

🚀 Quick Start

The aaPanel MCP Interface offers a comprehensive set of APIs for managing diverse aspects of the aaPanel system. It enables users to access system information, manage websites, databases, Docker containers and images, and handle email accounts.

✨ Features

• Retrieve panel system information and network status.
• Query the list of PHP websites.
• Create new PHP websites.
• Query the list of MySQL databases.
• Docker container management:
  • View the list of containers.
  • View detailed information about containers.
• Docker image management:
  • View the list of local images.
• Email management:
  • Add email accounts.
  • View the list of emails.
• Retrieve public configuration information of the panel.
• More features are under development...

📦 Installation

Prerequisites

• Go version 1.18 or higher.
• Access rights to the aaPanel API.
• An aaPanel API token.

Install from Source Code

# Clone the repository
git clone https://github.com/aaPanel/mcp-server.git
cd mcp_btpanel

# Install dependencies
go mod tidy

# Build the project
make build

# Build the Windows version
.\build.bat build

Direct Download

You can also download pre - compiled binary files from the release page.

📚 Documentation

Configuration Guide

Environment Variable Configuration

Configure the program through environment variables:

# Set the aaPanel address
export BT_BASE_URL="http://your-panel-address:8888"

# Set the aaPanel API token
export BT_API_TOKEN="your-api-token"

Configuration in Cursor

When using in Cursor, configure it as follows:

1. Open Cursor Settings > Extensions > MCP Tools.
2. Add a new MCP tool.
3. Fill in the configuration in the following format:

{
    "mcpServers": {
        "mcp-aapanel": {
            "command": "C:\\path\\to\\mcp-server.exe",
            "env": {
                "BT_BASE_URL": "http://192.168.xx.xx:8888/",
                "BT_API_TOKEN": "xxxxxxxxxxxxxxxxxxxxxxxx"
            }
        }
    }
}

Adding New Features

1. Create or modify files in the corresponding module directory.
2. Define new tool constants and tool objects.
3. Implement the handling functions.
4. Register the tool in the registerTools function in main.go.

Build and Deployment

Use the Makefile for building:

# Build the project
make build

# Build the Windows version
make build-windows

# Clean up build artifacts
make clean

# View more commands
make help

📄 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

💡 Contribution Guide

We welcome the submission of issues and feature requests! If you wish to contribute code:

1. Fork this repository.
2. Create or modify a 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. Submit a Pull Request.