Mcp 1panel

What is Mcp 1panel about?

Mcp 1panel provides a bridge between the Model Context Protocol (MCP) used by development assistants and the 1Panel control‑panel API. It enables external tools to query and manipulate 1Panel resources without writing custom API calls.

How to use Mcp 1panel?

1. Installation
   • Release binary: Download the appropriate executable from the GitHub releases page, make it executable, and place it in a directory on your PATH.
   • Build from source: Clone the repo, ensure Go 1.23+ is installed, then run make build and move ./build/mcp-1panel to your PATH.
   • Go install: go install github.com/1Panel-dev/mcp-1panel@latest
   • Docker: Pull 1panel/1panel-mcp-server and run it with the required environment variables.
2. Running modes
   • stdio (default): Run the binary directly or via Docker; configure the client to call the command.
   • sse: Start the server with -transport sse -addr http://localhost:8000 and point the client to the /sse endpoint.
3. Configuration example (stdio)

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

4. Configuration example (Docker stdio)

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

Key Features of Mcp 1panel

• Supports both stdio and SSE transports.
• Simple command‑line flags: -host, -token, -transport, -addr.
• Docker image available for all major architectures (amd64, arm64, arm/v7, s390x, ppc64le).
• Built‑in tool set covering system status, website management, SSL certificates, application installation, and database operations.
• Minimal configuration – only the 1Panel host URL and an access token are required.

Use Cases of Mcp 1panel

• IDE assistants (e.g., Cursor, Windsurf) need real‑time access to server resources while coding.
• Automation scripts that interact with 1Panel via MCP without handling raw HTTP calls.
• CI/CD pipelines that provision websites, databases, or install applications on a 1Panel instance.
• Monitoring dashboards that pull system and application data through the MCP interface.

FAQ

Q: Which transport should I choose? A: Use stdio for local binary execution (default). Choose sse when you need a long‑living HTTP endpoint, such as when running the server in a container.

Q: Do I need to rebuild the binary for different OS/arch? A: No, just download the pre‑built binary from the Releases page that matches your platform, or use the multi‑arch Docker image.

Q: How do I obtain the PANEL_ACCESS_TOKEN? A: Generate a token in the 1Panel UI under Access Tokens or via the 1Panel API.

Q: Can I run multiple MCP servers for different 1Panel instances? A: Yes, define separate entries under mcpServers with distinct command/env values.

Q: Is there a way to list all available tools? A: Run mcp-1panel --help or inspect the tools directory in the source code; the README also lists them.

[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)

1. Visit the Releases Page and download the executable file corresponding to 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

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

1. Clone the repository:

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

2. 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

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: 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