📌Overview

Purpose: The framework serves as an implementation of the Model Context Protocol (MCP) server for 1Panel, enabling efficient management and interaction with 1Panel features.

Overview: 1Panel MCP Server provides a streamlined interface for managing various aspects of the 1Panel ecosystem. Built to facilitate the integration of the Model Context Protocol, it enhances the operational capacity of 1Panel by offering tools for system management, website, certificate, application, and database handling.

Key Features:

• Multi-transport capabilities: Supports both standard input/output (stdio) and server-sent events (sse) modes, providing flexibility in communication methods.

• Extensive toolset: Includes commands for monitoring dashboard status, managing websites, creating SSL certificates, and handling database operations, allowing users to perform a wide array of administrative tasks seamlessly.

---

1Panel MCP Server

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

Installation

Prerequisites

• Go 1.23.0 or higher
• Existing 1Panel

Build from Source

1. Clone the repository:

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

2. Build the project:

   make build
   

   Move ./build/mcp-1panel to your system's environment path.

Install using go install

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

Usage

Configuration Example

Cursor and Windsurf configuration example:

stdio mode

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

sse mode

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

{
  "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)

Environment Variables

• PANEL_HOST: 1Panel access address
• PANEL_ACCESS_TOKEN: 1Panel access token

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 all installed applications
install_openresty	Application	Install OpenResty
install_mysql	Application	Install MySQL
list_databases	Database	List all databases
create_database	Database	Create a database