1Panel

A MCP server for automated website deployment to 1Panel (Experimental)

javascript

34

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

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

This MCP server automates the deployment of static websites to 1Panel by creating websites when needed and uploading your build files. It exposes a simple MCP tool to deploy a site and provides a straightforward way to configure and run the server from your development environment.

How to use

You interact with the server through your MCP client. To deploy a website to 1Panel you use the deploy_website tool, providing the domain of the site and, if you have a prebuilt build, the path to the build directory. The flow is designed to create the website if it does not exist and then upload all files from your build directory to 1Panel.

How to install

Prerequisites you need before starting:

Install Node.js and npm on your system.

Install and run the MCP server client or workspace that will host the MCP configuration.

Configuration and usage notes

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

Troubleshooting and notes

If deployment issues occur, verify that your API key is valid and has the necessary permissions. Ensure the target website directory exists and is writable. Check 1Panel server logs for detailed error information. If file uploads fail, inspect file permissions and formats.

Available tools

deploy_website

Deploys a website to 1Panel by creating the site if needed and uploading the build directory contents. Returns deployment status, domain, URL, and upload statistics.