https://github.com/1panel-dev/mcp-1panel
mcp-1panel is an implementation of the Model Context Protocol (MCP) server for 1Panel.
https://github.com/1panel-dev/mcp-1panel
1panel mcp mcp-server
Last synced: 3 months ago
JSON representation
mcp-1panel is an implementation of the Model Context Protocol (MCP) server for 1Panel.
- Host: GitHub
- URL: https://github.com/1panel-dev/mcp-1panel
- Owner: 1Panel-dev
- License: gpl-3.0
- Created: 2025-03-18T05:55:42.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-14T06:50:28.000Z (6 months ago)
- Last Synced: 2025-06-17T13:11:58.493Z (4 months ago)
- Topics: 1panel, mcp, mcp-server
- Language: Go
- Homepage: https://1panel.pro
- Size: 71.3 KB
- Stars: 127
- Watchers: 9
- Forks: 17
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 1Panel MCP Server
**1Panel MCP Server** is an implementation of the Model Context Protocol (MCP) server for [1Panel](https://github.com/1Panel-dev/1Panel).
## Installation Methods
### Method 1: Download from Release Page (Recommended)
1. Visit the [Releases Page](https://github.com/1Panel-dev/mcp-1panel/releases) and download the executable file corresponding to your system.
2. Example installation (for amd64):
```bash
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:
```bash
git clone https://github.com/1Panel-dev/mcp-1panel.git
cd mcp-1panel
```
2. Build the executable:
```bash
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:
```bash
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:
```json
{
"mcpServers": {
"mcp-1panel": {
"command": "mcp-1panel",
"env": {
"PANEL_ACCESS_TOKEN": "",
"PANEL_HOST": "such as http://localhost:8080"
}
}
}
}
```
#### 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": ""
}
}
}
}
```
### sse Mode
1. Start the MCP Server:
```bash
mcp-1panel -host http://localhost:8080 -token -transport sse -addr http://localhost:8000
```
2. Configure in Cursor or Windsurf:
```json
{
"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 |