1. 服务概述
一句话简介:通过自然语言部署和管理您的基础设施,支持任何MCP兼容的AI助手
- 服务名称:PlugLayer MCP Server
- 版本号:最新版本
- 开发者/提供方:pluglayer
- 协议类型:MCP (Model Context Protocol)
2. 核心功能
PlugLayer MCP Server提供以下主要功能:
- 用户身份验证与角色管理:通过Authentik提供用户身份和访问控制
- Docker镜像部署:支持部署Docker镜像和Docker Compose应用到托管基础设施
- CI/CD集成:生成GitHub Actions工作流实现自动化部署
- 项目管理:创建和管理项目命名空间
- 计算节点管理:添加和管理个人SSH计算节点
- 自定义域名管理:添加、验证和附加自定义域名到应用
- 部署管理:查看部署状态、日志、重新部署和回滚
- 集群健康检查:检查集群状态和运行状况
3. 使用场景
PlugLayer MCP Server适用于以下场景:
- 容器化应用部署:快速部署Docker容器应用到生产环境
- 基础设施管理:通过自然语言管理云基础设施资源
- CI/CD流程自动化:自动生成和配置GitHub Actions工作流
- 多环境管理:管理开发、测试和生产环境的项目和部署
- 自定义域名配置:为应用配置和管理自定义域名及DNS记录
- 日志监控:实时查看应用日志和运行状态
4. 接入方式
4.1 服务端点
PlugLayer MCP Server支持以下运行方式:
- 本地运行:通过uvx或pip安装本地运行
- 远程HTTP服务:托管服务运行在
mcp.pluglayer.com
4.2 认证与权限
PlugLayer使用API密钥进行认证:
- 在PlugLayer设置页面创建PlugLayer API令牌
- 使用
PLUGLAYER_API_KEY环境变量传递令牌 - 远程HTTP访问使用Bearer Token认证:
Authorization: Bearer your-pluglayer-api-token
4.3 数据格式
MCP服务与PlugLayer FastAPI后端通信,所有数据通过JSON格式传输,支持:
- 项目配置信息
- 部署状态和日志
- 计算节点信息
- 域名DNS记录配置
4.4 服务器配置
在MCP客户端配置中添加服务:
{ "mcpServers": { "pluglayer": { "command": "uvx", "args": ["pluglayer-mcp"], "env": { "PLUGLAYER_API_KEY": "your-pluglayer-api-token", "PLUGLAYER_API_BASE_URL": "https://api.pluglayer.com" } } } }5. 接口定义
PlugLayer MCP Server提供丰富的工具接口:
| 工具名称 | 功能描述 |
|---|---|
get_current_user | 显示Authentik支持的用户和角色 |
list_projects | 列出认证用户的项目 |
create_project | 创建新项目命名空间 |
deploy_image | 将Docker镜像部署到PlugLayer托管环境 |
deploy_compose | 从docker-compose.yml部署应用 |
list_deployments | 列出运行中的应用和部署 |
get_deployment_status | 检查应用状态和URL |
get_logs | 获取应用日志 |
redeploy | 重新部署应用 |
rollback | 回滚到之前的版本 |
add_custom_domain | 添加自定义域名并返回DNS记录 |
generate_github_actions | 生成CI/CD流水线YAML配置 |
get_cluster_health | 检查集群状态 |
6. 快速开始
6.1 环境要求
- Python 3.8或更高版本
- uvx或pip包管理器
- PlugLayer账户和API密钥
- MCP兼容的客户端(如Claude Desktop、Cursor等)
6.2 示例代码
安装方式一:使用uvx(推荐)
PLUGLAYER_API_KEY=your-pluglayer-api-token uvx pluglayer-mcp安装方式二:使用pip
pip install pluglayer-mcp PLUGLAYER_API_KEY=your-pluglayer-api-token pluglayer-mcp使用示例对话:
# 部署应用 "我有一个FastAPI应用在 ghcr.io/myorg/api:latest,运行在8000端口。将其部署到我的production项目。" # 转换docker-compose "这是我的docker-compose.yml:[粘贴内容]。将其部署到PlugLayer。" # 添加节点 "将我的服务器192.168.1.100添加为个人计算节点。这是我的SSH密钥:[粘贴密钥]" # CI/CD设置 "为我的api部署生成GitHub Actions工作流,以便在推送到main分支时自动部署。"7. 注意事项
- API密钥安全:API密钥只在创建时显示一次,请妥善保存
- 认证方式:MCP和编辑器插件应使用PlugLayer API令牌,而非浏览器/会话认证令牌
- 镜像仓库:托管镜像仓库由PlugLayer管理员在平台UI/API中配置
- 计算资源检查:部署前会进行后端计算资源检查
- Kubernetes密钥同步:使用镜像时,后端会自动同步Kubernetes拉取密钥
- 环境变量:
PLUGLAYER_API_BASE_URL是首选环境变量,默认为https://api.pluglayer.com - 管理员功能:部分管理员工具(如admin_get_overview)仅限管理员使用