Skip to content

Update MCP server configuration examples to use environment variables #3163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
octo-ryanhall merged 2 commits into from
May 21, 2026
Merged

Update MCP server configuration examples to use environment variables #3163

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c190c9e
Update MCP server configuration examples to use environment variables…
octo-ryanhall May 21, 2026
5a5ad23
Fix MD linting issues
octo-ryanhall May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/pages/docs/octopus-ai/mcp/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: An overview of the the Octopus MCP server, allowing AI clients to l
navOrder: 2
---

### Octopus MCP Server
## Octopus MCP Server

The Octopus MCP ([Model Context Protocol](https://modelcontextprotocol.io/)) server represents a significant leap forward in AI integration capabilities. Built on Anthropic's open standard for connecting AI assistants to external data sources and tools, the MCP server enables AI assistants like Claude to interact directly with your Octopus Deploy infrastructure.

Expand All @@ -33,25 +33,32 @@ To learn more, read our [Octopus REST API](/docs/octopus-rest-api) documentation
## 🚀 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):

```json
{
"mcpServers": {
"octopusdeploy": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@octopusdeploy/mcp-server", "--api-key", "YOUR_API_KEY", "--server-url", "https://your-octopus.com"]
"args": ["-y", "@octopusdeploy/mcp-server"],
"env": {
"OCTOPUS_SERVER_URL": "https://your-octopus.com",
"OCTOPUS_API_KEY": "YOUR_API_KEY"
}
}
}
}
```

The Octopus MCP Server is typically configured within your AI Client of choice.
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.

Expand All @@ -62,14 +69,17 @@ npx -y @octopusdeploy/mcp-server
```

With configuration provided via environment variables:

```bash
OCTOPUS_API_KEY=API-KEY
OCTOPUS_SERVER_URL=https://your-octopus.com
```

Or with configuration supplied via the command line:

```bash
npx -y @octopusdeploy/mcp-server --server-url https://your-octopus.com --api-key YOUR_API_KEY
OCTOPUS_API_KEY=API-KEY \
npx -y @octopusdeploy/mcp-server --server-url https://your-octopus.com
```

For detailed documentation visit [the official Github repo](https://github.com/OctopusDeploy/mcp-server).
For detailed documentation visit [the official Github repo](https://github.com/OctopusDeploy/mcp-server).
Loading