1panel MCP

🚀 1Panel MCP Server

A Model Context Protocol (MCP) server for automatically deploying websites to 1Panel.

⚠️ Important Note

Currently, this project is experimental and not intended for direct use.

🎥 Video Demo

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

✨ Features

• Automatically deploy websites to 1Panel servers.
• Create a new website if it doesn't exist.
• Upload static website files to 1Panel.
• Fully compatible with the MCP standard protocol.

🚀 Quick Start

Configure MCP in Cursor IDE

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

1. Open Cursor.
2. 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>"
      }
    }
  }
}

Deploy a Website Using MCP

In Cursor, you can use the following command to deploy a website via AI chat:

Deploy the website to 1Panel with the domain name yourdomain.com

Or use the following format:

Deploy to the 1Panel server, domain name: yourdomain.com

📚 Documentation

API Reference

MCP Tool: deploy_website

Deploy a website to 1Panel.

Parameters:

• domain (required): The domain name of the website.
• buildDir (optional): The path to the build directory.

Response:

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

🔧 Technical Details

Deployment Process

1. Check the build directory: Verify if the specified build directory exists.
2. Website creation: Create a new static website via the 1Panel API if it doesn't exist.
3. File upload: Upload all files from the build directory to the website.
4. Statistics: Return detailed statistics about the upload process.

💡 Troubleshooting

If you encounter issues during deployment, please check the following:

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