README
🚀 1Panel MCP 服务器
1Panel MCP 服务器是一个用于自动化部署网站到 1Panel 的 模型上下文协议(MCP) 服务器,能有效提升网站部署效率。
⚠️ 重要提示
目前该项目仍处于实验阶段,并不意味着可以直接投入使用。
🚀 快速开始
视频演示
您可以通过以下视频直观了解该项目的使用:https://www.bilibili.com/video/BV1SjQRY3EmM/
✨ 主要特性
- 自动化部署网站到 1Panel 服务器,节省大量时间和精力。
- 可创建不存在的网站,方便快捷。
- 能上传静态网站文件到 1Panel。
- 完全兼容 MCP 标准协议,具有良好的通用性。
📦 安装指南
文档中未提及具体安装步骤,暂不提供相关内容。
💻 使用示例
在 Cursor IDE 中配置 MCP
要使用此服务器与 Cursor IDE 配合,添加以下 MCP 配置:
- 打开 Cursor。
- 创建
.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>"
}
}
}
}
使用 MCP 部署网站
在 Cursor 中,您可以通过以下命令在 AI 聊天窗口中部署网站:
将网站部署到 1Panel,域名为 yourdomain.com
或使用以下格式:
将网站部署到 1Panel 服务器,域名:yourdomain.com
📚 详细文档
API 参考
MCP 工具:deploy_website
部署网站到 1Panel。 参数:
domain(必填):网站域名buildDir(可选):构建目录路径
响应:
成功部署到 1Panel!
域名:yourdomain.com
URL:http://yourdomain.com
上传统计信息:
- 总文件数:25
- 成功上传:25
- 失败上传:0
🔧 技术细节
部署流程
- 检查构建目录:验证指定的构建目录是否存在。
- 网站创建:通过 1Panel API 创建新的静态网站(如果不存在)。
- 文件上传:从构建目录上传所有文件到网站。
- 统计信息:返回有关上传过程的详细统计数据。
💡 使用建议
如果您在部署过程中遇到问题,请检查以下内容:
- 确保您的 API 密钥有效且具有足够的权限。
- 验证网站目录存在且有写入权限。
- 检查 1Panel 服务器日志以获取更详细的错误信息。
- 如果文件上传失败,可能是由于文件权限或格式问题。
Scan to join WeChat group