🚀 章鱼部署MCP服务器
这是一个用于与章鱼部署（Octopus Deploy）进行交互的模型上下文协议（MCP）服务器。该服务器提供了通过MCP协议管理项目、版本和部署的工具。
✨ 主要特性
- 项目管理：列出并查询章鱼部署项目
- 版本管理：获取最新版本并创建新版本
- 部署管理：部署版本并检查部署状态
- 多空间支持：可在不同的章鱼部署空间中工作
- 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替换为您实际的章鱼部署服务器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
# 使用您的章鱼部署凭证编辑.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
- 您的章鱼部署服务器URL
- 具有适当权限的有效章鱼部署API密钥
故障排除
常见问题
-
“未找到空间 'Default'”
- 验证您的章鱼服务器URL是否正确
- 检查您的API密钥是否有权限访问指定的空间
- 确保空间名称存在（区分大小写）
-
“身份验证失败”
- 验证您的API密钥是否正确且未过期
- 检查API密钥是否具有必要的权限
-
Docker构建失败
- 确保Docker正在运行
- 检查您是否有足够的磁盘空间
- 验证下载依赖项时的网络连接
调试模式
服务器会自动启用调试日志记录。请检查MCP客户端日志以获取详细的错误信息。
📄 许可证
如需反馈问题或提出疑问，请在GitHub上创建一个issue。