1panel

🚀 1Panel MCP Server

1Panel MCP Server is the implementation of the Model Context Protocol (MCP) server for 1Panel. It provides a reliable and efficient way to manage and interact with the context models in 1Panel.

🚀 Quick Start

✨ Features

• Supports two running modes: stdio and sse.
• Provides multiple installation methods, including downloading from the release page, building from source code, using go install, and Docker installation.
• Comes with a set of useful tools for managing and monitoring the MCP server.

📦 Installation

Method 1: Download from the Release Page (Recommended)

1. Visit the release page and download the executable file suitable for your system.
2. 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 Code

Make sure Go 1.23 or a higher version is installed locally. Then run the following commands:

1. Clone the repository:

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

2. Build the executable file:

make build

Move ./build/mcp-1panel to a directory included in the system PATH.

Method 3: Install via go install

Ensure that Go 1.23 or a higher version 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 Examples

Basic Usage

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

stdio Mode

Using Local Binary File

Add the following to the configuration file of Cursor or Windsurf:

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

Running with 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

1. Start the MCP server:

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

2. Configure in Cursor or Windsurf:

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

Command-line Options

• -token: 1Panel access token
• -host: Default listening address
• -transport: Supported transport type (default is http)
• -addr: Listening address and port
• -loglevel: Log level
• -version: Display version information

📚 Documentation

Available Tools

The MCP server provides the following tools:

These tools can help you better manage and monitor the MCP server.