aaPanel MCP server

This MCP server provides an interface to aaPanel, allowing you to manage your websites, databases, Docker containers, and email accounts through the Model Context Protocol. It simplifies panel operations by providing a structured API for various management tasks.

Installation Options

Installing from Source

You can build the MCP server from source code with these commands:

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

# Install dependencies
go mod tidy

# Build project
make build

# Build for Windows
.\build.bat build

Installing from Pre-compiled Binaries

For a quicker setup, download the pre-compiled binaries from the Releases page on GitHub.

Configuration

Setting Up Environment Variables

Configure the MCP server using environment variables:

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

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

Configuring in Cursor Application

To use the MCP server within Cursor:

1. Open Cursor Settings > Extensions > MCP Tools
2. Add a new MCP tool
3. Use the following configuration 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"
            }
        }
    }
}

Usage

Once configured, the MCP server provides access to these features:

• System Information: Get panel system information and network status
• PHP Website Management:
  • Query list of PHP websites
  • Create new PHP websites
• MySQL Database Management: Query database lists
• Docker Management:
  • View container lists and details
  • View local Docker images
• Email Management:
  • Add new email accounts
  • View email lists
• Panel Configuration: Access public configuration information

Building Custom Versions

You can build the application using the provided Makefile:

# Build project
make build

# Build Windows version
make build-windows

# Clean build artifacts
make clean

# View more commands
make help

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

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

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "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 an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect