Skip to content
Merged
Changes from 3 commits
Commits
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
29 changes: 20 additions & 9 deletions src/pages/docs/octopus-ai/mcp/use-cases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,20 @@
navOrder: 1
---

Below are some typical example use cases that might give you a good starting point to experiment with the Octopus Deploy MCP server.

We are eager to hear how you use it and what features you would like to see included in future versions.

## Capability: Change Management

Reason about what changes have been deployed where, to help you understand what your customers are using in production.

Example: 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.
### Production Version Tracking

Check failure on line 18 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines

src/pages/docs/octopus-ai/mcp/use-cases.mdx:18 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Production Version Tracking"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md022.md
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.

### 📝 Prompt
#### 📝 Example Prompt
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your document outline will have many of the same headings, is it possible to make each unique. For example: "Example version tracking prompt"?


```

Check failure on line 23 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Fenced code blocks should have a language specified

src/pages/docs/octopus-ai/mcp/use-cases.mdx:23 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md040.md
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?
```

Expand All @@ -23,33 +28,39 @@

Get to the root cause of failures or unhealthy deployment targets, allowing you to more quickly recover from failures.

Example: Check for failed deployments or unhealthy kubernetes workloads, analyze the failure reasons and suggest solutions.
### Deployment Health Analysis

### 📝 Prompt
Check for failed deployments or unhealthy kubernetes workloads, analyze the failure reasons and suggest solutions.

#### 📝 Example Prompt

Check failure on line 35 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Multiple headings with the same content

src/pages/docs/octopus-ai/mcp/use-cases.mdx:35 MD024/no-duplicate-heading Multiple headings with the same content [Context: "📝 Example Prompt"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md024.md

```

Check failure on line 37 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Fenced code blocks should have a language specified

src/pages/docs/octopus-ai/mcp/use-cases.mdx:37 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md040.md
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
```

### 💡 Tips for customizing
#### 💡 Tips for customizing

- Prompt for kubernetes status to trigger kubernetes [live object status](/docs/kubernetes/live-object-status) check

## Capability: Administration, Audit, and Compliance

Ensure your Octopus instance is in optimal shape, and that deployments continue to execute happily and healthily.

Example: Identify unhealthy resources, expiring certificates or find unused projects in your Octopus instance.
### Certificate Expiry Monitoring

Check failure on line 50 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Trailing spaces

src/pages/docs/octopus-ai/mcp/use-cases.mdx:50:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md009.md
Identify unhealthy resources, expiring certificates or find unused projects in your Octopus instance.

### 📝 Prompt
#### 📝 Example Prompt

Check failure on line 53 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Multiple headings with the same content

src/pages/docs/octopus-ai/mcp/use-cases.mdx:53 MD024/no-duplicate-heading Multiple headings with the same content [Context: "📝 Example Prompt"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md024.md

```

Check failure on line 55 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Fenced code blocks should have a language specified

src/pages/docs/octopus-ai/mcp/use-cases.mdx:55 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md040.md
Find certificates soon set to expire in {SpaceName} space
```

Example: Find configured resources in your Octopus instance and check if they have access to the desired targets.
### Resource Access Validation

Find configured resources in your Octopus instance and check if they have access to the desired targets.

### 📝 Prompt
#### 📝 Example Prompt

Check failure on line 63 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Multiple headings with the same content

src/pages/docs/octopus-ai/mcp/use-cases.mdx:63 MD024/no-duplicate-heading Multiple headings with the same content [Context: "📝 Example Prompt"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md024.md

```

Check failure on line 65 in src/pages/docs/octopus-ai/mcp/use-cases.mdx

View workflow job for this annotation

GitHub Actions / lint

Fenced code blocks should have a language specified

src/pages/docs/octopus-ai/mcp/use-cases.mdx:65 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.40.0/doc/md040.md
Check accounts configured in {SpaceName} space in my Octopus instance, find the preproduction azure account and then check which resources are available in that subscription using the azure mcp
Expand Down
Loading