-
Notifications
You must be signed in to change notification settings - Fork 99
Update MCP server use cases styling #2829
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.
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
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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
|
||
| 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 | ||
|
|
||
| ``` | ||
|
Check failure on line 23 in src/pages/docs/octopus-ai/mcp/use-cases.mdx
|
||
| 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? | ||
| ``` | ||
|
|
||
|
|
@@ -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
|
||
|
|
||
| ``` | ||
|
Check failure on line 37 in src/pages/docs/octopus-ai/mcp/use-cases.mdx
|
||
| 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
|
||
| 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
|
||
|
|
||
| ``` | ||
|
Check failure on line 55 in src/pages/docs/octopus-ai/mcp/use-cases.mdx
|
||
| 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
|
||
|
|
||
| ``` | ||
|
Check failure on line 65 in src/pages/docs/octopus-ai/mcp/use-cases.mdx
|
||
| 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 | ||
|
|
||
There was a problem hiding this comment.
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"?