Octopus Deploy MCP Server

这是一个用于与Octopus Deploy交互的Model Context Protocol (MCP)服务器。该服务器通过MCP协议提供了管理项目、发布和部署的工具。

功能

• 项目管理：列出并查询Octopus Deploy项目
• 发布管理：获取最新发布的版本并创建新的发布版本
• 部署管理：部署发布版本并检查部署状态
• 多空间支持：与不同的Octopus Deploy空间进行工作
• Docker支持：容器化部署以实现轻松集成

安装

1. 克隆仓库

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

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密钥",
      "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）

# 如果尚未安装，请安装UV
curl -LsSf https://astral.sh/uv/install.sh | sh

# 安装依赖项
uv sync

# 设置环境变量
cp .env.sh.example .env.sh
# 使用您的Octopus Deploy凭据编辑.env.sh

# 直接运行服务器
source .env.sh

# 在可编辑模式下安装包
uv pip install -e .
uv run octopus-deploy-mcp

# 或者使用fastmcp-cli工具进行开发
fastmcp dev dev.py

测试Docker构建

# 在本地测试Docker镜像
./scripts/test-docker.sh

要求

• Docker
• 您的Octopus Deploy服务器URL
• 具有适当权限的有效Octopus Deploy API密钥

故障排除

常见问题

1. “未找到空间'Default'”

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

2. “身份验证失败”

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

3. Docker构建失败

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

调试模式

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

支持

对于问题和疑问，请在GitHub上创建问题。