You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-ai/mcp/index.mdx
+62-1Lines changed: 62 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,4 +9,65 @@ description: An overview of the the Octopus MCP server, allowing AI clients to l
9
9
navOrder: 2
10
10
---
11
11
12
-
TODO: Content for an Octopus MCP landing page.
12
+
### Octopus MCP Server
13
+
14
+
The upcoming 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 will enable AI assistants like Claude to interact directly with your Octopus Deploy infrastructure.
15
+
16
+
The Octopus MCP server provides similar capabilities to the Octopus AI Assistant, but provides further benefits:
17
+
18
+
- You can use it with your client and model of choice.
19
+
- It can work alongside other MCP servers to accomplish more complex orchestrations across Octopus and your other essential software services.
20
+
21
+
The MCP server provides tools designed to solve key use-cases within change management, troubleshooting, administration audit & compliance, and standardization at scale.
22
+
23
+
The MCP server architecture ensures that your deployment data remains secure while enabling powerful AI-assisted workflows. All interactions are logged and auditable, maintaining the compliance and governance standards your organization requires.
24
+
25
+
We are releasing the MCP server as an open source tool that anyone can contribute to. It is available for free on Github at [https://github.com/OctopusDeploy/mcp-server](https://github.com/OctopusDeploy/mcp-server)
26
+
27
+
:::div{.info}
28
+
This project is currently in Early Access, and subject to breaking changes.
29
+
:::
30
+
31
+
## π Installation
32
+
33
+
### Requirements
34
+
- Node.js >= v20.0.0
35
+
- Octopus Deploy instance that can be accessed by the MCP server via HTTPS
36
+
- Octopus Deploy API Key
37
+
38
+
### Configuration
39
+
40
+
Full example configuration (for Claude Desktop, Claude Code, and Cursor):
The Octopus MCP Server is typically configured within your AI Client of choice.
53
+
54
+
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 Octoups MCP Server package and provide the Octopus Server URL and API key required, if they are not available as environment variables.
55
+
56
+
The command line invocation you will be configuring will be one of the two following variants:
57
+
58
+
```bash
59
+
npx -y @octopusdeploy/mcp-server
60
+
```
61
+
62
+
With configuration provided via environment variables:
63
+
```bash
64
+
OCTOPUS_API_KEY=API-KEY
65
+
OCTOPUS_SERVER_URL=https://your-octopus.com
66
+
```
67
+
68
+
Or with configuration supplied via the command line:
Copy file name to clipboardExpand all lines: src/pages/docs/octopus-ai/mcp/use-cases.mdx
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,39 +11,43 @@ navOrder: 1
11
11
12
12
Quickly find out what version of your software a customer, represented by a Tenant, is running in Production, and identify if there were any issues with their most recent deployment.
13
13
14
-
## π Prompt
14
+
###π Prompt
15
15
16
16
```
17
17
Customer X have submitted a support ticket complaining that there is a bug in the latest release of App. Can you tell me what release they are on, when it was deployed, and if there were any issues with the deployment?
18
18
```
19
19
20
20
## Capability: Troubleshooting
21
21
22
-
TODO: Something about diagnosing deployment failure. K8s - live object status to show failure.
22
+
Check for failed deployments or unhealthy kubernetes workloads, analyze the failure reasons and suggest solutions.
23
23
24
-
## π Prompt
24
+
###π Prompt
25
25
26
26
```
27
-
TODO
27
+
Check health of the {ServiceName} service in the {SpaceName} space and report any issues found, check status of kubernetes services to produce a comprehensive report
28
28
```
29
29
30
+
### π‘ Tips for customizing
31
+
32
+
- Prompt for kubernetes status to trigger kubernetes [live object status](/docs/kubernetes/live-object-status) check
33
+
30
34
## Capability: Administration, Audit, and Compliance
31
35
32
-
TODO: something about providing a list of certificates in a space that are expiring in the next x months.
36
+
Identify unhealthy resources, expiriting certificates or find unused projects in your Octopus instance.
33
37
34
-
## π Prompt
38
+
###π Prompt
35
39
36
40
```
37
-
TODO
41
+
Find certificates soon set to expire in {SpaceName} space
38
42
```
39
43
40
-
## Capability: Standardization at Scale
44
+
## Capability: Configuration Management
41
45
42
46
TODO: something about finding an account that will provide you access to a particular azure subscription.
0 commit comments