- Octopus Deploy Official Mcp Server
Octopus Deploy Official Mcp Server
Octopus Deploy Official MCP Server
Octopus makes it easy to deliver software to Kubernetes, multi-cloud, on-prem infrastructure, and anywhere else. Automate the release, deployment, and operations of your software and AI workloads with a tool that can handle CD at scale in ways no other tool can.
Model Context Protocol (MCP) allows the AI assistants you use in your day to day work, like Claude Code, or ChatGPT, to connect to the systems and services you own in a standardized fashion, allowing them to pull information from those systems and services to answer questions and perform tasks.
The Octopus MCP Server provides your AI assistant with powerful tools that allow it to inspect, query, and diagnose problems within your Octopus instance, transforming it into your ultimate DevOps wingmate. For a list of supported use-cases and sample prompts, see our documentation.
This project is currently in Early Access, and subject to breaking changes.
Octopus Server Compatibility
Most tools exposed by the MCP Server use stable APIs that have been available from at least version 2021.1 of Octopus Server. Tools that are newer will specify the minimum supported version in the documentation. Alternatively, you can use the command line argument --list-tools-by-version to check how specific tools relate to versions of Octopus.
🚀 Installation
Requirements
- Node.js >= v20.0.0
- Octopus Deploy instance that can be accessed by the MCP server via HTTPS
- Octopus Deploy API Key
Configuration
Full example configuration (for Claude Desktop, Claude Code, and Cursor):
{
"mcpServers": {
"octopusdeploy": {
"command": "npx",
"args": ["-y", "@octopusdeploy/mcp-server", "--api-key", "YOUR_API_KEY", "--server-url", "https://your-octopus.com"]
}
}
}
The Octopus MCP Server is typically configured within your AI Client of choice.
It is packaged as an npm package and executed via Node's npx command. Your configuration will include the command invocation npx, and a set of arguments that supply the Octopus MCP Server package and provide the Octopus Server URL and API key required, if they are not available as environment variables.
The command line invocation you will be configuring will be one of the two following variants:
npx -y @octopusdeploy/mcp-server
With configuration provided via environment variables:
OCTOPUS_API_KEY=API-KEY
OCTOPUS_SERVER_URL=https://your-octopus.com
Or with configuration supplied via the command line:
npx -y @octopusdeploy/mcp-server --server-url https://your-octopus.com --api-key YOUR_API_KEY
Server Config
{
"mcpServers": {
"octopusdeploy": {
"command": "npx",
"args": [
"-y",
"@octopusdeploy/mcp-server",
"--api-key",
"YOUR_API_KEY",
"--server-url",
"https://your-octopus.com"
]
}
}
}