1Panel

What is mcp-1panel?

mcp-1panel is an implementation of the Model Context Protocol (MCP) server specifically designed for 1Panel. It acts as a bridge, allowing external applications (like Cursor or Windsurf) to interact with and manage your 1Panel instance through the MCP.

How to use mcp-1panel?

mcp-1panel can be installed in several ways:

Download from Release Page (Recommended): Download the executable for your system from the GitHub Releases page.
Build from Source: Clone the repository and build the executable using make build (requires Go 1.23+).
Install via go install: Use go install github.com/1Panel-dev/mcp-1panel@latest (requires Go 1.23+).
Install via Docker: Use the official Docker image which supports multiple architectures.

Once installed, mcp-1panel supports two running modes: stdio and sse.

stdio Mode: Configure your application (e.g., Cursor, Windsurf) to run mcp-1panel as a command, providing PANEL_ACCESS_TOKEN and PANEL_HOST as environment variables. This can be done with a local binary or by running it within Docker.
sse Mode: Start the mcp-1panel server with the -transport sse flag, specifying the 1Panel host, token, and the SSE server address. Then, configure your application to connect to the provided SSE URL.

Key Features of mcp-1panel

1Panel Integration: Seamlessly interacts with 1Panel to manage various aspects of your server.
Multiple Installation Methods: Offers flexibility in deployment through direct download, source build, go install, or Docker.
Two Running Modes: Supports stdio for direct command execution and sse for persistent server communication.
Comprehensive Toolset: Provides a wide range of tools for managing system, websites, certificates, applications, and databases within 1Panel.

Use Cases of mcp-1panel

Automated Server Management: Automate tasks like creating websites, installing applications (e.g., OpenResty, MySQL), and managing databases on your 1Panel instance.
Integration with Development Environments: Integrate 1Panel functionalities directly into IDEs or other development tools that support MCP, such as Cursor or Windsurf.
Scripting and Orchestration: Use mcp-1panel within scripts or orchestration tools to programmatically control your 1Panel server.

FAQ from mcp-1panel

What is the Model Context Protocol (MCP)? MCP is a protocol that allows external applications to interact with and manage services, in this case, 1Panel.
What are the supported architectures for Docker? The official Docker image supports amd64, arm64, arm/v7, s390x, and ppc64le.
What tools are available through mcp-1panel? A variety of tools are available, including those for getting dashboard/system info, listing/creating websites, listing/creating SSLs, listing/installing applications (like OpenResty, MySQL), and listing/creating databases.

[English] | [中文(简体)]

1Panel MCP Server

1Panel MCP Server is an implementation of the Model Context Protocol (MCP) server for 1Panel.

Installation Methods

Method 1: Download from Release Page (Recommended)

Visit the Releases Page and download the executable file corresponding to your system.
Example installation (for amd64):

chmod +x mcp-1panel-linux-amd64
mv mcp-1panel-linux-amd64 /usr/local/bin/mcp-1panel

Method 2: Build from Source

Make sure Go 1.23 or later is installed locally. Then run:

Clone the repository:

git clone https://github.com/1Panel-dev/mcp-1panel.git
cd mcp-1panel

Build the executable:

make build

Move ./build/mcp-1panel to a directory included in your system's PATH.

Method 3: Install via go install

Make sure Go 1.23 or later is installed locally. Then run:

go install github.com/1Panel-dev/mcp-1panel@latest

Method 4: Install via Docker

Make sure Docker is correctly installed and configured on your machine.

The official image supports the following architectures:

amd64
arm64
arm/v7
s390x
ppc64le

Usage

1Panel MCP Server supports two running modes: stdio and sse.

stdio Mode

Using Local Binary

In the configuration file of Cursor or Windsurf, add:

{
  "mcpServers": {
    "mcp-1panel": {
      "command": "mcp-1panel",
      "env": {
        "PANEL_ACCESS_TOKEN": "<your 1Panel access token>",
        "PANEL_HOST": "such as http://localhost:8080"
      }
    }
  }
}

Running in Docker

{
  "mcpServers": {
    "mcp-1panel": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "PANEL_HOST",
        "-e",
        "PANEL_ACCESS_TOKEN",
        "1panel/1panel-mcp-server"
      ],
      "env": {
        "PANEL_HOST": "such as http://localhost:8080",
        "PANEL_ACCESS_TOKEN": "<your 1Panel access token>"
      }
    }
  }
}

sse Mode

Start the MCP Server:

mcp-1panel -host http://localhost:8080 -token <your 1Panel access token> -transport sse -addr http://localhost:8000

Configure in Cursor or Windsurf:

{
  "mcpServers": {
    "mcp-1panel": {
      "url": "http://localhost:8000/sse"
    }
  }
}

Command Line Options

-token: 1Panel access token
-host: 1Panel access address
-transport: Transport type (stdio or sse, default: stdio)
-addr: Start SSE server address (default: http://localhost:8000)

Available Tools

The server provides various tools for interacting with 1Panel:

Tool	Category	Description
get_dashboard_info	System	List dashboard status
get_system_info	System	Get system information
list_websites	Website	List all websites
create_website	Website	Create a website
list_ssls	Certificate	List all certificates
create_ssl	Certificate	Create a certificate
list_installed_apps	Application	List installed apps
install_openresty	Application	Install OpenResty
install_mysql	Application	Install MySQL
list_databases	Database	List all databases
create_database	Database	Create a database

1Panel Overview