mcp-1panel

command module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2025 License: GPL-3.0 Imports: 12 Imported by: 0

README

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 (for binary usage)
  • Docker (for Docker usage)
  • Existing 1Panel installation
Build from Source (Binary)
  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 a directory included in your system's PATH.

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

Usage

You can use 1Panel MCP Server with tools like Cursor and Windsurf.

stdio Mode
Binary

Make sure Go is installed and the binary is built or installed:

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

Make sure Docker is installed:

{
  "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 with SSE:

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

Cursor/Windsurf configuration:

{
  "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 addr (default:http://localhost:8000)
Environment Variables

You can also configure the server using 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

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
operations
app
ssl

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL