Octopus Deploy MCP Server

Name: Octopus Deploy MCP Server
Author: Octopus Deploy

Octopus DeployOfficial

Get started Repository

Lets agents query, inspect and manage an Octopus Deploy instance, including projects, releases and deployments.

Setup

Choose your client, copy the config, then fill in any required environment variables.

Add to Cursor Add to VS Code

claude mcp add octopus-deploy --env OCTOPUS_API_KEY='<OCTOPUS_API_KEY>' --env OCTOPUS_SERVER_URL='<OCTOPUS_SERVER_URL>' -- npx -y @octopusdeploy/mcp-server --server-url '{{config.OCTOPUS_SERVER_URL}}' --api-key '{{config.OCTOPUS_API_KEY}}'

~/.codex/config.toml

[mcp_servers.octopus-deploy]
command = "npx"
args = ["-y", "@octopusdeploy/mcp-server", "--server-url", "{{config.OCTOPUS_SERVER_URL}}", "--api-key", "{{config.OCTOPUS_API_KEY}}"]
env = { OCTOPUS_API_KEY = "<OCTOPUS_API_KEY>", OCTOPUS_SERVER_URL = "<OCTOPUS_SERVER_URL>" }

# codex mcp add octopus-deploy --env OCTOPUS_API_KEY='<OCTOPUS_API_KEY>' --env OCTOPUS_SERVER_URL='<OCTOPUS_SERVER_URL>' -- npx -y @octopusdeploy/mcp-server --server-url '{{config.OCTOPUS_SERVER_URL}}' --api-key '{{config.OCTOPUS_API_KEY}}'

~/.cursor/mcp.json

{
  "mcpServers": {
    "octopus-deploy": {
      "command": "npx",
      "args": [
        "-y",
        "@octopusdeploy/mcp-server",
        "--server-url",
        "{{config.OCTOPUS_SERVER_URL}}",
        "--api-key",
        "{{config.OCTOPUS_API_KEY}}"
      ],
      "env": {
        "OCTOPUS_API_KEY": "<OCTOPUS_API_KEY>",
        "OCTOPUS_SERVER_URL": "<OCTOPUS_SERVER_URL>"
      }
    }
  }
}

.vscode/mcp.json

{
  "servers": {
    "octopus-deploy": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@octopusdeploy/mcp-server",
        "--server-url",
        "{{config.OCTOPUS_SERVER_URL}}",
        "--api-key",
        "{{config.OCTOPUS_API_KEY}}"
      ],
      "env": {
        "OCTOPUS_API_KEY": "<OCTOPUS_API_KEY>",
        "OCTOPUS_SERVER_URL": "<OCTOPUS_SERVER_URL>"
      }
    }
  }
}

~/.gemini/settings.json

{
  "mcpServers": {
    "octopus-deploy": {
      "command": "npx",
      "args": [
        "-y",
        "@octopusdeploy/mcp-server",
        "--server-url",
        "{{config.OCTOPUS_SERVER_URL}}",
        "--api-key",
        "{{config.OCTOPUS_API_KEY}}"
      ],
      "env": {
        "OCTOPUS_API_KEY": "<OCTOPUS_API_KEY>",
        "OCTOPUS_SERVER_URL": "<OCTOPUS_SERVER_URL>"
      }
    }
  }
}

claude_desktop_config.json

{
  "mcpServers": {
    "octopus-deploy": {
      "command": "npx",
      "args": [
        "-y",
        "@octopusdeploy/mcp-server",
        "--server-url",
        "{{config.OCTOPUS_SERVER_URL}}",
        "--api-key",
        "{{config.OCTOPUS_API_KEY}}"
      ],
      "env": {
        "OCTOPUS_API_KEY": "<OCTOPUS_API_KEY>",
        "OCTOPUS_SERVER_URL": "<OCTOPUS_SERVER_URL>"
      }
    }
  }
}

.trae/mcp.json

{
  "mcpServers": {
    "octopus-deploy": {
      "command": "npx",
      "args": [
        "-y",
        "@octopusdeploy/mcp-server",
        "--server-url",
        "{{config.OCTOPUS_SERVER_URL}}",
        "--api-key",
        "{{config.OCTOPUS_API_KEY}}"
      ],
      "env": {
        "OCTOPUS_API_KEY": "<OCTOPUS_API_KEY>",
        "OCTOPUS_SERVER_URL": "<OCTOPUS_SERVER_URL>"
      }
    }
  }
}

Environment variables

OCTOPUS_API_KEY
OCTOPUS_SERVER_URL

Replace the placeholders with your own credentials and keep them out of version control.

Setup

Environment variables

Related