Octopus Deploy MCP服务器

Octopus Deploy MCP服务器是一个通过MCP协议管理项目、发布和部署的工具,支持多空间操作和Docker容器化部署。

  • by armanzeroeight
  • Python
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 armanzeroeight/octopus-deploy-mcp-server

使用说明

八达通部署MCP服务器

用于与Octopus Deploy交互的模型上下文协议(MCP)服务器。此服务器提供通过MCP协议管理项目、发布和部署的工具。

特性

  • 项目管理:列出并查询Octopus Deploy项目
  • 发布管理:获取最新版本并创建新版本
  • 部署管理:部署版本并检查部署状态
  • 多空间支持:使用不同的Octopus Deploy空间
  • Docker支持:容器化部署,易于集成

安装

1.克隆存储库

git clone https://github.com/armanzeroeight/octopus-deploy-mcp-server.git
cd octopus-deploy-mcp

2.构建Docker镜像

./scripts/build.sh

这将创建一个标记为的Docker镜像 octopus-deploy-mcp:latest.

MCP配置

将以下配置添加到MCP客户端 mcp.json 文件:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "octopus-api-key",
      "description": "Octopus Deploy API key",
      "password": true
    }
  ],
  "servers": {
    "octopus-deploy-mcp-server": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "OCTOPUS_URL",
        "-e",
        "OCTOPUS_API_KEY",
        "octopus-deploy-mcp:latest",
        "octopus-deploy-mcp"
      ],
      "env": {
        "OCTOPUS_URL": "https://your-octopus-server.com",
        "OCTOPUS_API_KEY": "${input:octopus-api-key}"
      }
    }
  }
}

配置说明

  • 替换 https://your-octopus-server.com 使用您的实际Octopus Deploy服务器URL(无 /api 后缀)
  • 当MCP客户端启动时,将安全提示API密钥
  • Docker镜像必须使用构建脚本在本地构建

可用工具

项目工具

  • list_projects:列出空间中的所有项目
  • get_project_details:获取特定项目的详细信息

发布工具

  • get_latest_release:获取项目的最新版本
  • create_release:为项目创建新版本

部署工具

  • deploy_release:将版本部署到环境中
  • check_deployment_status:检查部署状态

发展

本地安装程序(不含Docker)

# Install UV if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh

# Install dependencies
uv sync

# Set up environment variables
cp .env.sh.example .env.sh
# Edit .env.sh with your Octopus Deploy credentials

# Run the server directly
source .env.sh

# Install the package in editable mode
uv pip install -e .
uv run octopus-deploy-mcp

# Or use fastmcp-cli tool for development
fastmcp dev dev.py

测试Docker构建

# Test the Docker image locally
./scripts/test-docker.sh

需求

  • 码头工人
  • 您的Octopus Deploy服务器URL
  • 具有适当权限的有效Octopus Deploy API密钥

故障排除

常见问题

  1. 未找到“默认”空格

    • 验证您的八达通服务器URL是否正确
    • 检查您的API密钥是否有权访问指定的空间
    • 确保空间名称存在(区分大小写)
  2. “身份验证失败”

    • 验证您的API密钥是否正确并且尚未过期
    • 检查API密钥是否具有必要的权限
  3. Docker构建失败

    • 确保Docker正在运行
    • 检查是否有足够的磁盘空间
    • 验证下载依赖项的互联网连接

调试模式

服务器自动启用调试日志记录。检查MCP客户端日志以获取详细的错误信息。

支持

有关问题和疑问,请在GitHub上创建问题。