Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OCTOPUS_API_KEY | Yes | Your Octopus Deploy API key | |
| OCTOPUS_SERVER_URL | Yes | The URL of your Octopus Deploy server (e.g., https://your-octopus.com) |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_spaces | List all spaces in the Octopus Deploy instance. Spaces is the main organizational unit in Octopus Deploy, Spaces keep the different projects, infrastructure and tenants completely separate. Spaces typically represent team or project boundary, but not customer boundary (use tenants for those). Always use this tool first to check that the requested space exists. |
| list_projects | This tool lists all projects in a given space. Projects let you manage software applications and services, each with their own deployment process, lifecycles, and variables. Projects are where you define what you are deploying and how it should be deployed. The space name is required, if you can't find the space name, ask the user directly for the name of the space. Optionally filter by partial name match using partialName parameter. |
| list_environments | List environments in a space This tool lists all environments in a given space. The space name is required. Use this tool as early as possible to understand which environments are configured. Optionally filter by partial name match using partialName parameter. |
| list_deployments | List deployments in a space This tool lists deployments in a given space. The space name is required. When requesting latest deployment consider which deployment state the user is interested in (successful or all). Optional filters include: projects (array of project IDs), environments (array of environment IDs), tenants (array of tenant IDs), channels (array of channel IDs), taskState (one of: Canceled, Cancelling, Executing, Failed, Queued, Success, TimedOut), and take (number of results to return). |
| get_release_by_id | Get details for a specific release by its ID |
| list_releases | List releases in a space This tool lists all releases in a given space. The space name is required. Optionally provide skip and take parameters for pagination. |
| list_releases_for_project | List releases for a specific project This tool lists all releases for a given project in a space. The space name and project ID are required. Optionally provide skip, take, and searchByVersion parameters. |
| get_task_by_id | Get details for a specific server task by its ID. Tasks represent background operations in Octopus Deploy, such as deployments, health checks, and system maintenance. Each task has a unique ID and can be monitored for status and progress. |
| get_task_details | Get detailed information for a specific server task by its ID. Tasks represent background operations in Octopus Deploy, such as deployments, health checks, and system maintenance. Each task has a unique ID and can be monitored for status and progress. |
| get_task_raw | Get raw details for a specific server task by its ID |
| list_tenants | List tenants in a space This tool lists all tenants in a given space. The space name is required. Optionally provide skip and take parameters for pagination. |
| get_tenant_by_id | Get details for a specific tenant by its ID. Tenants represent customers or clients in Octopus Deploy, allowing you to manage deployments and configurations specific to each tenant. Tenants can be grouped into tenant tags for easier management and deployment targeting. Tenants can also represent geographical locations, organizational units, or any other logical grouping. |
| get_tenant_variables | Get tenant variables by type This tool retrieves different types of tenant variables. Use variableType parameter to specify which type:
|
| get_missing_tenant_variables | Get missing tenant variables This tool retrieves tenant variables that are missing values. Optionally filter by tenant, project, or environment. |
| get_kubernetes_live_status | Get Kubernetes live status for a project and environment This tool retrieves the live status of Kubernetes resources for a specific project and environment. Optionally include a tenant ID for multi-tenant deployments. |
| list_deployment_targets | List deployment targets (machines) in a space This tool lists all deployment targets in a given space. The space name is required. You can optionally filter by various parameters like name, roles, health status, etc. |
| get_deployment_target | Get a specific deployment target (machine) by ID This tool retrieves detailed information about a specific deployment target using its ID. The space name and target ID are both required. |
| get_deployment_process | Get deployment process by ID This tool retrieves a deployment process by its ID. Each project has a deployment process attached, and releases/deployments can also have frozen processes attached. |
| get_branches | Get Git branches for a version-controlled project This tool retrieves Git branches for a specific project in a space. The space name and project ID are required. Optionally provide searchByName, skip, and take parameters for filtering and pagination. |
| get_current_user | Get information about the current authenticated user This tool retrieves information about the currently authenticated user from the Octopus Deploy API. |
| list_certificates | List certificates in a space This tool lists all certificates in a given space. The space name is required. You can optionally filter by various parameters like name, archived status, tenant, etc. |
| get_certificate | Get details for a specific certificate by its ID This tool retrieves detailed information about a specific certificate using its ID. The space name and certificate ID are both required. |
| list_accounts | List accounts in a space This tool lists all accounts in a given space. The space name is required. You can optionally filter by various parameters like name, account type, etc. |
| get_account | Get details for a specific account by its ID This tool retrieves detailed information about a specific account using its ID. The space name and account ID are both required. |
| get_variables | This tool gets all project and library variable set variables for a given project. Projects can contain variables (specific to a project), library variable sets (shared collections of variables associated with many projects), and tenant variables (variables related to a tenants connected to the project) If you want to retrieve tenant variables for a tenant connected to the project, use the get_tenant_variables tool. |