Octopus Deploy Mcp Server

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-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. 「Space 'Default' not found」

   • Octopus サーバーの URL が正しいことを確認してください
   • API キーに指定したスペースへのアクセス権があることを確認してください
   • スペース名が存在することを確認してください（大文字と小文字は区別されます）

2. 「Authentication failed」

   • API キーが正しく、有効期限が切れていないことを確認してください
   • API キーに必要な権限があることを確認してください

3. Docker のビルドに失敗する

   • Docker が実行中であることを確認してください
   • 十分なディスク容量があることを確認してください
   • 依存関係をダウンロードできるよう、インターネットに接続されていることを確認してください

デバッグモード

サーバーではデバッグログが自動的に有効になります。詳細なエラー情報については、MCP クライアントのログを確認してください。

サポート

問題や質問がある場合は、GitHub で issue を作成してください。