Octopus Deploy Mcp Server

Octopus Deploy 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

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

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

要求

• Docker
• Octopus Deploy 服务 URL
• 具有相应权限的有效 Octopus Deploy API 密钥

故障排除

常见问题

1. “未找到空间 ‘Default’”

   • 确认 Octopus 服务 URL 正确
   • 检查 API 密钥是否有权访问指定空间
   • 确认空间名称存在（区分大小写）

2. “身份验证失败”

   • 确认 API 密钥正确且未过期
   • 检查 API 密钥是否具有必要的权限

3. Docker 构建失败

   • 确保 Docker 正在运行
   • 检查磁盘空间是否充足
   • 确认网络连接正常，以便下载依赖项

调试模式

服务会自动启用调试日志。请查看 MCP 客户端日志以获取详细的错误信息。

支持

如有问题或疑问，请在 GitHub 上创建 issue。