Add it to Claude Code
claude mcp add -e "ONEPANEL_API_KEY=${ONEPANEL_API_KEY}" 1panel-mcp -- 1panel-mcp-server startONEPANEL_API_KEY+ 3 optionalMake your agent remember this setup
1panel-mcp's config, env vars, and the gotchas you hit — recalled in every future Claude Code, Cursor, and Codex session.
npx conare@latestFree · one command · indexes the sessions already on disk. Set up in the browser instead →
What it does
- Access to 264 tools covering 1Panel's complete API
- Full support for Docker containers, images, networks, and volumes
- Comprehensive database management for MySQL, PostgreSQL, and Redis
- System monitoring including processes, cronjobs, and firewall management
- Website management including SSL, Nginx, and anti-leech settings
Tools 1
1panel_api_toolsProvides access to 264 tools covering 1Panel's complete API for containers, databases, websites, and system management.Environment Variables
ONEPANEL_HOST1Panel host addressONEPANEL_PORT1Panel port numberONEPANEL_API_KEYrequired1Panel API keyONEPANEL_PROTOCOLhttp or httpsTry it
Original README from EaveLuo/1panel-mcp
1Panel MCP Server
MCP (Model Context Protocol) server for 1Panel - Manage your 1Panel through AI agents like Claude, Cursor, or any MCP-compatible client.
Features
- 264 Tools covering 1Panel's complete API
- 100% Open Source version coverage
- ~90% Professional (XPack) version coverage
- Modular architecture with TypeScript
Supported Modules
Core: Containers, Images, Networks, Volumes, Docker Compose Applications: App Store, Runtime Environments, PHP, Node.js Files: File Management, Backup, Recycle Bin, Snapshots Database: MySQL, PostgreSQL, Redis Website: Websites, SSL, Nginx, AntiLeech System: Monitor, Processes, Cronjobs, Firewall, Fail2ban Security: SSH, Terminal, ClamAV Antivirus AI & Advanced: AI Agent, MCP Server, Ollama, GPU, OpenResty Host Management: Remote Hosts, SSH Keys
Installation
Global Installation (Recommended)
npm install -g 1panel-mcp-server
Local Installation
npm install 1panel-mcp-server
Usage
Quick Start
Get your 1Panel API key:
- Login to 1Panel web interface
- Go to Profile → API
- Generate or copy your API key
Start the MCP server:
# Using environment variables
export ONEPANEL_API_KEY=your-api-key
export ONEPANEL_HOST=localhost
export ONEPANEL_PORT=8080
1panel-mcp-server start
# Using command line options
1panel-mcp-server start --host 192.168.1.100 --port 8080 --key your-api-key
# Using HTTPS
1panel-mcp-server start --host panel.example.com --secure --key your-api-key
# Using short command
1pmcp start --key your-api-key
Commands
1panel-mcp-server --help # Show help
1panel-mcp-server start --help # Show start options
1panel-mcp-server config # Show configuration guide
1panel-mcp-server tools # List available tools
# Or use short command
1pmcp --help
1pmcp start --key your-api-key
Environment Variables
| Variable | Description | Default |
|---|---|---|
ONEPANEL_HOST |
1Panel host | localhost |
ONEPANEL_PORT |
1Panel port | 8080 |
ONEPANEL_API_KEY |
1Panel API key (required) | - |
ONEPANEL_PROTOCOL |
http or https |
http |
MCP Configuration
Claude Desktop
Add to claude_desktop_config.json:
{
"mcpServers": {
"1panel": {
"command": "1panel-mcp-server",
"args": ["start"],
"env": {
"ONEPANEL_HOST": "localhost",
"ONEPANEL_PORT": "8080",
"ONEPANEL_API_KEY": "your-api-key"
}
}
}
}
Cursor
Add to Cursor MCP settings:
{
"mcpServers": {
"1panel": {
"command": "1panel-mcp-server",
"args": ["start", "--host", "localhost", "--port", "8080", "--key", "your-api-key"]
}
}
}
Development
# Clone the repository
git clone https://github.com/EaveLuo/1panel-mcp.git
cd 1panel-mcp
# Install dependencies
npm install
# Build
npm run build
# Development mode
npm run dev
# Start locally
npm start
# Or use the CLI
npm link
1panel-mcp-server start --key your-api-key
API Coverage
| Category | Tools | Coverage |
|---|---|---|
| Open Source | 205 | 100% |
| XPack (Pro) | 59 | ~90% |
| Total | 264 | ~98% |
License
MIT