1P

1Panel

Created 5 months ago

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

development documentation public

What is 1Panel?

MCP server implementation that provides 1Panel interaction.

Documentation

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
```\n\n### Method 2: Build from Source
Make sure Go 1.23 or later is installed locally. Then run:
1. Clone the repository:
```bash
git clone https://github.com/1Panel-dev/mcp-1panel.git
cd mcp-1panel
  1. Build the executable:
make build

Move ./build/mcp-1panel to a directory included in your system's PATH.\n\n### 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
```\n\n### 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`.\n\n### stdio Mode## Using Local Binary
In the configuration file of Cursor or Windsurf, add:
```json
{
  "mcpServers": {
    "mcp-1panel": {
      "command": "mcp-1panel",
      "env": {
        "PANEL_ACCESS_TOKEN": "",
        "PANEL_HOST": "such as http://localhost:8080"
      }
    }
  }
}
```\n\n#### Running in Docker
```json
{
  "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": ""
      }
    }
  }
}
```\n\n### sse Mode
1. Start the MCP Server:
```bash
mcp-1panel -host http://localhost:8080 -token -transport sse -addr http://localhost:8000
  1. Configure in Cursor or Windsurf:
{
  "mcpServers": {
    "mcp-1panel": {
      "url": "http://localhost:8000/sse"
    }
  }
}
```\n\n#### 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 |

Server Config

{
  "mcpServers": {
    "1panel-server": {
      "command": "npx",
      "args": [
        "1panel"
      ]
    }
  }
}

Links & Status

Repository: github.com
Hosted: No
Global: No
Official: Yes

Project Info

Hosted Featured
Created At: Jul 02, 2025
Updated At: Aug 07, 2025
Author: 1Panel Development Team
Category: community
License: MIT
Tags:
development documentation public