项目简介

Komodo MCP Server是一个基于Model Context Protocol (MCP) 构建的后端服务,旨在将AI助手(如Claude、GitHub Copilot)无缝集成到Komodo容器管理平台中。它允许用户通过自然语言命令或自动化脚本对Komodo管理的Docker或Podman容器、部署和服务器进行高效操作,例如启动、停止容器,管理部署栈,以及获取服务器状态等。

主要功能点

  • 容器管理: 轻松启动、停止、重启、暂停和恢复Docker容器,并监控容器列表和状态。
  • 部署与应用栈: 部署和更新容器,管理Docker Compose应用栈,支持多环境部署和完整的应用生命周期控制。
  • 服务器操作: 列出所有Komodo管理的服务器,获取服务器统计信息,进行健康监控和资源跟踪。
  • AI助手兼容: 与任何兼容MCP协议的AI客户端(如Claude Desktop, VS Code Copilot Chat)无缝协作,支持Stdio和SSE两种传输协议。
  • 自动化集成: 支持n8n等自动化平台,构建容器健康检查和部署管道等自动化工作流。

安装步骤

本服务器推荐通过Docker进行部署,以确保环境一致性和便捷性。

推荐方法:使用Docker

  1. 拉取Docker镜像: 打开终端或命令行工具,执行以下命令拉取最新版本的Komodo MCP Server Docker镜像:
    docker pull ghcr.io/mp-tool/komodo-mcp-server:latest
  2. 通过Docker Compose运行: 如果您已安装Docker Compose,可以按照以下步骤快速部署: a. 克隆仓库或下载示例配置:
    bash     git clone https://github.com/MP-Tool/komodo-mcp-server.git     cd komodo-mcp-server/examples/compose     
    b. 复制'.env.example'文件并将其重命名为'.env':
    bash     cp .env.example .env     
    c. 编辑'.env'文件: 打开新创建的'.env'文件,填入您的Komodo服务器URL、用户名和密码。这些信息是服务器连接Komodo平台所必需的。 d. 启动服务:
    bash     docker compose up -d     
    服务将在后台启动,默认监听主机的3000端口。

可选方法:本地开发环境(需要Node.js 20+)

  1. 克隆仓库并安装依赖:
    git clone https://github.com/MP-Tool/komodo-mcp-server.git
    cd komodo-mcp-server
    npm install
  2. 构建并运行:
    npm run build
    npm start
    服务器将启动,默认监听本地的3000端口。

服务器配置(供MCP客户端使用)

MCP服务器启动后,将在 '127.0.0.1:3000' 监听。要与MCP客户端连接,您需要提供服务器的启动命令和参数。以下是推荐的配置信息,请在您的MCP客户端(如Claude Desktop、VS Code Copilot Chat等)的相应设置界面中填写:

配置信息

  • 服务器名称 (server name): 'Komodo MCP Server' (这是一个用户友好的名称,您可根据喜好自定义)
  • 命令 (command): 'docker'
  • 参数 (args):
    • '"run"': Docker命令,用于运行一个新容器。
    • '"--rm"': 容器停止后自动移除,保持系统整洁。
    • '"-p", "3000:3000"': 将Docker容器内部的3000端口映射到您主机的3000端口,确保MCP客户端能够访问。
    • '"-e", "KOMODO_URL=<你的Komodo服务器URL>"': 设置连接Komodo容器管理平台的URL。例如:'http://localhost:9121' 或您的远程Komodo实例地址。
    • '"-e", "KOMODO_USERNAME=<你的Komodo用户名>"': 设置用于登录Komodo平台的用户名。
    • '"-e", "KOMODO_PASSWORD=<你的Komodo密码>"': 设置用于登录Komodo平台的密码。
    • '"ghcr.io/mp-tool/komodo-mcp-server:latest"': 指定要运行的Docker镜像名称及其标签。

请勿直接将以下JSON代码复制粘贴到命令行或作为文件保存。这仅是MCP客户端配置界面可能需要的参数结构示意。您应在客户端的用户界面中,将上述每个参数(字符串)分别填入对应的“命令”和“参数”字段。

{
  "name": "Komodo MCP Server",
  "command": "docker",
  "args": [
    "run",
    "--rm",
    "-p", "3000:3000",
    "-e", "KOMODO_URL=http://your-komodo-server:9121",
    "-e", "KOMODO_USERNAME=your_komodo_username",
    "-e", "KOMODO_PASSWORD=your_komodo_password",
    "ghcr.io/mp-tool/komodo-mcp-server:latest"
  ]
}

基本使用方法

一旦Komodo MCP Server与您的AI助手连接并配置成功,您就可以开始通过自然语言与Komodo平台交互。以下是一些您可以尝试的命令示例:

  • 列出所有服务器: '"List all my Komodo servers"'
  • 查看特定服务器上的容器: '"Show containers on production-server"'
  • 启动/停止/重启容器: '"Start the nginx container"' '"Stop the database container"' '"Restart the web-app on dev-server"'
  • 部署应用: '"Deploy my-app to staging"'
  • 获取服务器统计信息: '"Get stats for dev-server"'
  • 检查Komodo连接健康状态: '"Run a health check for Komodo"'
  • 配置Komodo客户端连接(如果尚未在环境变量中配置): '"Configure Komodo with URL http://example.com, username myuser, and password mypassword"'

服务器将解析您的请求,并通过预定义的工具调用Komodo API执行相应的操作,并将结果以易于理解的格式返回给AI助手。

信息

分类

开发者工具