From c190c9e2c195f71515df68f18d12fcb4acc278bb Mon Sep 17 00:00:00 2001 From: Ryan Hall Date: Thu, 21 May 2026 17:41:03 +1200 Subject: [PATCH 1/2] Update MCP server configuration examples to use environment variables for API key and server URL --- src/pages/docs/octopus-ai/mcp/index.mdx | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/pages/docs/octopus-ai/mcp/index.mdx b/src/pages/docs/octopus-ai/mcp/index.mdx index 38a19b04c2..1b98226279 100644 --- a/src/pages/docs/octopus-ai/mcp/index.mdx +++ b/src/pages/docs/octopus-ai/mcp/index.mdx @@ -44,14 +44,19 @@ Full example configuration (for Claude Desktop, Claude Code, and Cursor): { "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. @@ -69,7 +74,8 @@ 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). \ No newline at end of file From 5a5ad23d9deee8e1848217b5a76edfadde5e881c Mon Sep 17 00:00:00 2001 From: Ryan Hall Date: Thu, 21 May 2026 17:50:06 +1200 Subject: [PATCH 2/2] Fix MD linting issues --- src/pages/docs/octopus-ai/mcp/index.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/pages/docs/octopus-ai/mcp/index.mdx b/src/pages/docs/octopus-ai/mcp/index.mdx index 1b98226279..9c34c3dc6b 100644 --- a/src/pages/docs/octopus-ai/mcp/index.mdx +++ b/src/pages/docs/octopus-ai/mcp/index.mdx @@ -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. @@ -33,6 +33,7 @@ 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 @@ -40,6 +41,7 @@ To learn more, read our [Octopus REST API](/docs/octopus-rest-api) documentation ### Configuration Full example configuration (for Claude Desktop, Claude Code, and Cursor): + ```json { "mcpServers": { @@ -67,15 +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 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). \ No newline at end of file +For detailed documentation visit [the official Github repo](https://github.com/OctopusDeploy/mcp-server).