Skip to content

Commit fd76634

Browse files
committed
WIP mcp use cases
1 parent 20ded52 commit fd76634

File tree

2 files changed

+75
-10
lines changed

2 files changed

+75
-10
lines changed

β€Žsrc/pages/docs/octopus-ai/mcp/index.mdxβ€Ž

Lines changed: 62 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,65 @@ description: An overview of the the Octopus MCP server, allowing AI clients to l
99
navOrder: 2
1010
---
1111

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):
41+
```json
42+
{
43+
"mcpServers": {
44+
"octopusdeploy": {
45+
"command": "npx",
46+
"args": ["-y", "@octopusdeploy/mcp-server", "--api-key", "YOUR_API_KEY", "--server-url", "https://your-octopus.com"]
47+
}
48+
}
49+
}
50+
```
51+
52+
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:
69+
```bash
70+
npx -y @octopusdeploy/mcp-server --server-url https://your-octopus.com --api-key YOUR_API_KEY
71+
```
72+
73+
For detailed documentation visit [the official Github repo](https://github.com/OctopusDeploy/mcp-server).

β€Žsrc/pages/docs/octopus-ai/mcp/use-cases.mdxβ€Ž

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,39 +11,43 @@ navOrder: 1
1111

1212
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.
1313

14-
## πŸ“ Prompt
14+
### πŸ“ Prompt
1515

1616
```
1717
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?
1818
```
1919

2020
## Capability: Troubleshooting
2121

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.
2323

24-
## πŸ“ Prompt
24+
### πŸ“ Prompt
2525

2626
```
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
2828
```
2929

30+
### πŸ’‘ Tips for customizing
31+
32+
- Prompt for kubernetes status to trigger kubernetes [live object status](/docs/kubernetes/live-object-status) check
33+
3034
## Capability: Administration, Audit, and Compliance
3135

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.
3337

34-
## πŸ“ Prompt
38+
### πŸ“ Prompt
3539

3640
```
37-
TODO
41+
Find certificates soon set to expire in {SpaceName} space
3842
```
3943

40-
## Capability: Standardization at Scale
44+
## Capability: Configuration Management
4145

4246
TODO: something about finding an account that will provide you access to a particular azure subscription.
4347

4448
See if it can work together with Azure MCP.
4549

46-
## πŸ“ Prompt
50+
### πŸ“ Prompt
4751

4852
```
4953
TODO

0 commit comments

Comments
Β (0)