1Panel MCP Server

README

1Panel MCP Server

A Model Context Protocol (MCP) server for automated website deployment to 1Panel.

Important

Currently, this project is an experimental project and does not mean that it can be used directly.

Video demo

https://www.bilibili.com/video/BV1SjQRY3EmM/

Features

Automates website deployment to 1Panel servers
Creates websites if they don't already exist
Uploads static website files to 1Panel
Fully compatible with the MCP standard protocol

Usage

Configure MCP in Cursor IDE

To use this server with Cursor IDE, add the following MCP configuration:

Open Cursor
Create .cursor/mcp.json

{
  "mcpServers": {
    "1panel-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "1panel-mcp"
      ],
      "env": {
        "ONEPANEL_BASE_URL": "<your 1Panel base URL>",
        "ONEPANEL_API_KEY": "<your 1Panel API key>"
      }
    }
  }
}

Use MCP to Deploy Websites

In Cursor, you can deploy websites using the following command in the AI chat:

Deploy to 1Panel with domain=yourdomain.com

Or you can use the following format:

Deploy website to 1Panel server, domain: yourdomain.com

API Reference

MCP Tool: deploy_website

Deploys a website to 1Panel.

Parameters:

domain (required): Website domain
buildDir (optional): Build directory path

Response:

Successfully deployed to 1Panel!
Domain: yourdomain.com
URL: http://yourdomain.com
Upload statistics:
- Total files: 25
- Successfully uploaded: 25
- Failed to upload: 0

Implementation Details

Deployment Process

Check Build Directory: Verifies if the specified build directory exists
Website Creation: Creates a new static website through 1Panel API if it doesn't exist
File Upload: Uploads all files from the build directory to the website
Statistics: Returns detailed statistics about the upload process

Troubleshooting

If you encounter deployment issues, check the following:

Ensure your API Key is valid and has sufficient permissions
Verify that the website directory exists and has write permissions
Check the 1Panel server logs for more detailed error information
If file uploads fail, it may be due to file permission or format issues

1Panel-mcp FAQ

How do I configure 1Panel-mcp with my 1Panel account?

Set the ONEPANEL_BASE_URL and ONEPANEL_API_KEY environment variables in your MCP server configuration to connect securely.

Is 1Panel-mcp production-ready?

No, it is currently experimental and may require additional testing before production use.

Can 1Panel-mcp create websites automatically?

Yes, it can create websites on 1Panel if they do not already exist.

How does 1Panel-mcp handle static file uploads?

It uploads static website files directly to the specified 1Panel website via the MCP protocol.

Which IDEs support integration with 1Panel-mcp?

Cursor IDE supports 1Panel-mcp integration through MCP configuration, enabling seamless deployment workflows.

Does 1Panel-mcp support other hosting providers?

Currently, it is designed specifically for 1Panel and does not support other hosting platforms.

What MCP features does 1Panel-mcp implement?

It fully supports MCP standard protocol for server communication and deployment automation.

Can I use 1Panel-mcp with multiple websites?

Yes, it can manage multiple websites by creating and uploading files as needed per site.

1Panel-mcp

Use This MCP server To

README