关键词

1Panel面板管理网站管理数据库管理SSL证书管理系统监控

使用说明

项目简介

1Panel MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，专为 1Panel 设计。它允许 LLM 客户端通过标准化的 MCP 协议与 1Panel 面板进行交互，从而实现对服务器和应用的上下文感知和控制。

主要功能点

  • 系统信息获取: 提供获取服务器系统信息和面板仪表盘状态的功能，例如系统版本、CPU、内存使用率等。
  • 网站管理: 支持列出和创建网站，方便 LLM 应用自动化管理网站。
  • SSL证书管理: 支持列出和创建 SSL 证书，简化网站安全配置流程。
  • 应用管理: 支持列出已安装的应用，以及安装 OpenResty 和 MySQL 等常用应用。
  • 数据库管理: 支持列出和创建数据库，方便 LLM 应用进行数据库操作。

安装步骤

  1. 环境准备:

    • 确保已安装 Go 1.23.0 或更高版本。
    • 确保已安装并运行 1Panel 面板。

  2. 下载仓库:

    git clone https://github.com/1Panel-dev/mcp-1panel.git
cd mcp-1panel

  3. 构建项目:

    • 使用 'make build' 命令编译项目。 
      make build
    • 或使用 'go install' 命令直接安装。 
      go install github.com/1Panel-dev/mcp-1panel@latest
    • 构建成功后，将 './build/mcp-1panel' (或 'go install' 安装路径下的 'mcp-1panel' ) 添加到系统环境变量 'PATH' 中，以便在任何位置直接运行 'mcp-1panel' 命令。

服务器配置

MCP 客户端配置示例 (JSON):

stdio 模式 (默认):

{
  "mcpServers": {
    "mcp-1panel": {
      "command": "mcp-1panel",
      "env": {
        "PANEL_ACCESS_TOKEN": "<your 1Panel access token>",  // 替换为你的 1Panel 访问令牌
        "PANEL_HOST": "http://your_1panel_host:port"      // 替换为你的 1Panel 面板地址，例如 http://localhost:8080 或 http://192.168.1.100:8080
      }
    }
  }
}

sse 模式:

首先启动 sse 模式的 MCP 服务器：

mcp-1panel -host http://your_1panel_host:port -token <your 1Panel access token> -transport sse

然后 MCP 客户端配置如下：

{
  "mcpServers": {
    "mcp-1panel": {
        "url": "http://localhost:8000/sse" // SSE 服务器地址，默认端口为 8000
    }
  }
}

配置参数说明:

  • 'command': 启动 MCP 服务器的命令，这里是 'mcp-1panel' (假设已添加到 PATH)。
  • 'url': SSE 模式下 MCP 服务器的 URL 地址。
  • 'env': 环境变量配置，用于 stdio 模式。
    • 'PANEL_ACCESS_TOKEN': 必需。1Panel 面板的访问令牌，用于 API 鉴权。请在 1Panel 面板后台获取。
    • 'PANEL_HOST': 必需。1Panel 面板的访问地址，包括协议和端口。

命令行参数说明 (用于直接运行 'mcp-1panel'):

  • '-token': 1Panel 访问令牌 (等同于设置环境变量 'PANEL_ACCESS_TOKEN')。
  • '-host': 1Panel 访问地址 (等同于设置环境变量 'PANEL_HOST')。
  • '-transport': 传输类型，可选 'stdio' 或 'sse'，默认为 'stdio'。
  • '-sse-port': SSE 服务器端口，仅在 '-transport sse' 时生效，默认为 '8000'。

基本使用方法

  1. 启动 MCP 服务器: 根据选择的传输模式 (stdio 或 sse) 启动 'mcp-1panel' 服务器。对于 stdio 模式，通常由 MCP 客户端直接调用 'mcp-1panel' 命令启动；对于 sse 模式，需要手动运行命令启动。

  2. 配置 MCP 客户端: 在 LLM 应用 (MCP 客户端，如 Cursor, Windsurf) 中配置 'mcpServers'，填入上面生成的 JSON 配置信息，指定服务器名称、连接方式 (command 或 url) 以及必要的认证信息 (token, host)。

  3. 使用工具: 在 LLM 应用中，即可通过 MCP 协议调用 1Panel MCP Server 提供的工具，例如 'list_websites' (列出网站), 'create_database' (创建数据库) 等，与 1Panel 面板进行交互，实现自动化管理和控制。具体工具列表请参考仓库 README.md 中的 "Available Tools" 表格。

注意: 使用前请务必配置正确的 'PANEL_ACCESS_TOKEN' 和 'PANEL_HOST'，确保 MCP 服务器能够正常访问和操作 1Panel 面板。

信息

分类

开发者工具

访问项目