@octopusdeploy/mcp-server 1.0.1 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +237 -46
- package/dist/helpers/activeToolsetConfig.d.ts +4 -0
- package/dist/helpers/activeToolsetConfig.d.ts.map +1 -0
- package/dist/helpers/activeToolsetConfig.js +18 -0
- package/dist/helpers/activeToolsetConfig.js.map +1 -0
- package/dist/helpers/errorHandling.d.ts +38 -0
- package/dist/helpers/errorHandling.d.ts.map +1 -0
- package/dist/helpers/errorHandling.js +75 -0
- package/dist/helpers/errorHandling.js.map +1 -0
- package/dist/helpers/getClientConfigurationFromEnvironment.d.ts +2 -0
- package/dist/helpers/getClientConfigurationFromEnvironment.d.ts.map +1 -1
- package/dist/helpers/getClientConfigurationFromEnvironment.js +21 -5
- package/dist/helpers/getClientConfigurationFromEnvironment.js.map +1 -1
- package/dist/helpers/grepLines.d.ts +38 -0
- package/dist/helpers/grepLines.d.ts.map +1 -0
- package/dist/helpers/grepLines.js +65 -0
- package/dist/helpers/grepLines.js.map +1 -0
- package/dist/helpers/methodTier.d.ts +15 -0
- package/dist/helpers/methodTier.d.ts.map +1 -0
- package/dist/helpers/methodTier.js +25 -0
- package/dist/helpers/methodTier.js.map +1 -0
- package/dist/helpers/pathAllowlist.d.ts +27 -0
- package/dist/helpers/pathAllowlist.d.ts.map +1 -0
- package/dist/helpers/pathAllowlist.js +177 -0
- package/dist/helpers/pathAllowlist.js.map +1 -0
- package/dist/helpers/pathGlob.d.ts +15 -0
- package/dist/helpers/pathGlob.d.ts.map +1 -0
- package/dist/helpers/pathGlob.js +47 -0
- package/dist/helpers/pathGlob.js.map +1 -0
- package/dist/helpers/requireConfirmation.d.ts +119 -0
- package/dist/helpers/requireConfirmation.d.ts.map +1 -0
- package/dist/helpers/requireConfirmation.js +148 -0
- package/dist/helpers/requireConfirmation.js.map +1 -0
- package/dist/helpers/sensitivePathDenylist.d.ts +32 -0
- package/dist/helpers/sensitivePathDenylist.d.ts.map +1 -0
- package/dist/helpers/sensitivePathDenylist.js +49 -0
- package/dist/helpers/sensitivePathDenylist.js.map +1 -0
- package/dist/helpers/spaceResolver.d.ts +4 -0
- package/dist/helpers/spaceResolver.d.ts.map +1 -0
- package/dist/helpers/spaceResolver.js +18 -0
- package/dist/helpers/spaceResolver.js.map +1 -0
- package/dist/helpers/stripLinks.d.ts +15 -0
- package/dist/helpers/stripLinks.d.ts.map +1 -0
- package/dist/helpers/stripLinks.js +19 -0
- package/dist/helpers/stripLinks.js.map +1 -0
- package/dist/helpers/urlParser.d.ts +16 -0
- package/dist/helpers/urlParser.d.ts.map +1 -0
- package/dist/helpers/urlParser.js +83 -0
- package/dist/helpers/urlParser.js.map +1 -0
- package/dist/helpers/userCache.d.ts +14 -0
- package/dist/helpers/userCache.d.ts.map +1 -0
- package/dist/helpers/userCache.js +16 -0
- package/dist/helpers/userCache.js.map +1 -0
- package/dist/helpers/validateExecutePath.d.ts +29 -0
- package/dist/helpers/validateExecutePath.d.ts.map +1 -0
- package/dist/helpers/validateExecutePath.js +62 -0
- package/dist/helpers/validateExecutePath.js.map +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +64 -15
- package/dist/index.js.map +1 -1
- package/dist/resources/catalog/capabilities.d.ts +36 -0
- package/dist/resources/catalog/capabilities.d.ts.map +1 -0
- package/dist/resources/catalog/capabilities.js +90 -0
- package/dist/resources/catalog/capabilities.js.map +1 -0
- package/dist/resources/catalog/llmsTxt.d.ts +8 -0
- package/dist/resources/catalog/llmsTxt.d.ts.map +1 -0
- package/dist/resources/catalog/llmsTxt.js +44 -0
- package/dist/resources/catalog/llmsTxt.js.map +1 -0
- package/dist/resources/dispatch.d.ts +30 -0
- package/dist/resources/dispatch.d.ts.map +1 -0
- package/dist/resources/dispatch.js +81 -0
- package/dist/resources/dispatch.js.map +1 -0
- package/dist/resources/featureToggle.d.ts +2 -0
- package/dist/resources/featureToggle.d.ts.map +1 -0
- package/dist/resources/featureToggle.js +34 -0
- package/dist/resources/featureToggle.js.map +1 -0
- package/dist/resources/index.d.ts +12 -0
- package/dist/resources/index.d.ts.map +1 -0
- package/dist/resources/index.js +44 -0
- package/dist/resources/index.js.map +1 -0
- package/dist/resources/interruption.d.ts +2 -0
- package/dist/resources/interruption.d.ts.map +1 -0
- package/dist/resources/interruption.js +34 -0
- package/dist/resources/interruption.js.map +1 -0
- package/dist/resources/release.d.ts +2 -0
- package/dist/resources/release.d.ts.map +1 -0
- package/dist/resources/release.js +33 -0
- package/dist/resources/release.js.map +1 -0
- package/dist/resources/rolloutGroup.d.ts +2 -0
- package/dist/resources/rolloutGroup.d.ts.map +1 -0
- package/dist/resources/rolloutGroup.js +35 -0
- package/dist/resources/rolloutGroup.js.map +1 -0
- package/dist/resources/runbook.d.ts +2 -0
- package/dist/resources/runbook.d.ts.map +1 -0
- package/dist/resources/runbook.js +34 -0
- package/dist/resources/runbook.js.map +1 -0
- package/dist/resources/task.d.ts +2 -0
- package/dist/resources/task.d.ts.map +1 -0
- package/dist/resources/task.js +68 -0
- package/dist/resources/task.js.map +1 -0
- package/dist/tools/createRelease.d.ts +3 -0
- package/dist/tools/createRelease.d.ts.map +1 -0
- package/dist/tools/createRelease.js +151 -0
- package/dist/tools/createRelease.js.map +1 -0
- package/dist/tools/deployRelease.d.ts +3 -0
- package/dist/tools/deployRelease.d.ts.map +1 -0
- package/dist/tools/deployRelease.js +227 -0
- package/dist/tools/deployRelease.js.map +1 -0
- package/dist/tools/execute.d.ts +3 -0
- package/dist/tools/execute.d.ts.map +1 -0
- package/dist/tools/execute.js +261 -0
- package/dist/tools/execute.js.map +1 -0
- package/dist/tools/findAccounts.d.ts +3 -0
- package/dist/tools/findAccounts.d.ts.map +1 -0
- package/dist/tools/findAccounts.js +90 -0
- package/dist/tools/findAccounts.js.map +1 -0
- package/dist/tools/findCertificates.d.ts +3 -0
- package/dist/tools/findCertificates.d.ts.map +1 -0
- package/dist/tools/findCertificates.js +98 -0
- package/dist/tools/findCertificates.js.map +1 -0
- package/dist/tools/findDeploymentTargets.d.ts +3 -0
- package/dist/tools/findDeploymentTargets.d.ts.map +1 -0
- package/dist/tools/findDeploymentTargets.js +161 -0
- package/dist/tools/findDeploymentTargets.js.map +1 -0
- package/dist/tools/findFeatureToggles.d.ts +37 -0
- package/dist/tools/findFeatureToggles.d.ts.map +1 -0
- package/dist/tools/findFeatureToggles.js +139 -0
- package/dist/tools/findFeatureToggles.js.map +1 -0
- package/dist/tools/findInterruptions.d.ts +79 -0
- package/dist/tools/findInterruptions.d.ts.map +1 -0
- package/dist/tools/findInterruptions.js +273 -0
- package/dist/tools/findInterruptions.js.map +1 -0
- package/dist/tools/findReleases.d.ts +3 -0
- package/dist/tools/findReleases.d.ts.map +1 -0
- package/dist/tools/findReleases.js +138 -0
- package/dist/tools/findReleases.js.map +1 -0
- package/dist/tools/findRunbooks.d.ts +3 -0
- package/dist/tools/findRunbooks.d.ts.map +1 -0
- package/dist/tools/findRunbooks.js +139 -0
- package/dist/tools/findRunbooks.js.map +1 -0
- package/dist/tools/findTenants.d.ts +19 -0
- package/dist/tools/findTenants.d.ts.map +1 -0
- package/dist/tools/findTenants.js +133 -0
- package/dist/tools/findTenants.js.map +1 -0
- package/dist/tools/getBranches.d.ts.map +1 -1
- package/dist/tools/getBranches.js +51 -33
- package/dist/tools/getBranches.js.map +1 -1
- package/dist/tools/getCurrentUser.d.ts.map +1 -1
- package/dist/tools/getCurrentUser.js +34 -25
- package/dist/tools/getCurrentUser.js.map +1 -1
- package/dist/tools/getDeploymentFromUrl.d.ts +57 -0
- package/dist/tools/getDeploymentFromUrl.d.ts.map +1 -0
- package/dist/tools/getDeploymentFromUrl.js +162 -0
- package/dist/tools/getDeploymentFromUrl.js.map +1 -0
- package/dist/tools/getDeploymentProcess.d.ts.map +1 -1
- package/dist/tools/getDeploymentProcess.js +57 -19
- package/dist/tools/getDeploymentProcess.js.map +1 -1
- package/dist/tools/getKubernetesLiveStatus.d.ts.map +1 -1
- package/dist/tools/getKubernetesLiveStatus.js +70 -48
- package/dist/tools/getKubernetesLiveStatus.js.map +1 -1
- package/dist/tools/getMissingTenantVariables.d.ts.map +1 -1
- package/dist/tools/getMissingTenantVariables.js +58 -26
- package/dist/tools/getMissingTenantVariables.js.map +1 -1
- package/dist/tools/getTaskFromUrl.d.ts +18 -0
- package/dist/tools/getTaskFromUrl.d.ts.map +1 -0
- package/dist/tools/getTaskFromUrl.js +90 -0
- package/dist/tools/getTaskFromUrl.js.map +1 -0
- package/dist/tools/getTenantVariables.d.ts.map +1 -1
- package/dist/tools/getTenantVariables.js +58 -38
- package/dist/tools/getTenantVariables.js.map +1 -1
- package/dist/tools/getVariables.d.ts.map +1 -1
- package/dist/tools/getVariables.js +12 -9
- package/dist/tools/getVariables.js.map +1 -1
- package/dist/tools/grepLlmsTxt.d.ts +13 -0
- package/dist/tools/grepLlmsTxt.d.ts.map +1 -0
- package/dist/tools/grepLlmsTxt.js +105 -0
- package/dist/tools/grepLlmsTxt.js.map +1 -0
- package/dist/tools/grepTaskLog.d.ts +30 -0
- package/dist/tools/grepTaskLog.d.ts.map +1 -0
- package/dist/tools/grepTaskLog.js +116 -0
- package/dist/tools/grepTaskLog.js.map +1 -0
- package/dist/tools/index.d.ts +22 -18
- package/dist/tools/index.d.ts.map +1 -1
- package/dist/tools/index.js +33 -21
- package/dist/tools/index.js.map +1 -1
- package/dist/tools/listDeployments.d.ts.map +1 -1
- package/dist/tools/listDeployments.js +77 -37
- package/dist/tools/listDeployments.js.map +1 -1
- package/dist/tools/listEnvironments.d.ts.map +1 -1
- package/dist/tools/listEnvironments.js +63 -37
- package/dist/tools/listEnvironments.js.map +1 -1
- package/dist/tools/listProjects.d.ts.map +1 -1
- package/dist/tools/listProjects.js +64 -38
- package/dist/tools/listProjects.js.map +1 -1
- package/dist/tools/listSpaces.d.ts.map +1 -1
- package/dist/tools/listSpaces.js +56 -30
- package/dist/tools/listSpaces.js.map +1 -1
- package/dist/tools/readResource.d.ts +3 -0
- package/dist/tools/readResource.d.ts.map +1 -0
- package/dist/tools/readResource.js +50 -0
- package/dist/tools/readResource.js.map +1 -0
- package/dist/tools/runRunbook.d.ts +3 -0
- package/dist/tools/runRunbook.d.ts.map +1 -0
- package/dist/tools/runRunbook.js +174 -0
- package/dist/tools/runRunbook.js.map +1 -0
- package/dist/tools/updateFeatureToggle.d.ts +94 -0
- package/dist/tools/updateFeatureToggle.d.ts.map +1 -0
- package/dist/tools/updateFeatureToggle.js +308 -0
- package/dist/tools/updateFeatureToggle.js.map +1 -0
- package/dist/types/featureToggleTypes.d.ts +47 -0
- package/dist/types/featureToggleTypes.d.ts.map +1 -0
- package/dist/types/featureToggleTypes.js +10 -0
- package/dist/types/featureToggleTypes.js.map +1 -0
- package/dist/types/resourceConfig.d.ts +17 -0
- package/dist/types/resourceConfig.d.ts.map +1 -0
- package/dist/types/resourceConfig.js +6 -0
- package/dist/types/resourceConfig.js.map +1 -0
- package/dist/types/toolAnnotations.d.ts +8 -0
- package/dist/types/toolAnnotations.d.ts.map +1 -0
- package/dist/types/toolAnnotations.js +28 -0
- package/dist/types/toolAnnotations.js.map +1 -0
- package/dist/types/toolConfig.d.ts +7 -1
- package/dist/types/toolConfig.d.ts.map +1 -1
- package/dist/types/toolConfig.js +4 -1
- package/dist/types/toolConfig.js.map +1 -1
- package/dist/utils/parseConfig.d.ts +1 -1
- package/dist/utils/parseConfig.d.ts.map +1 -1
- package/dist/utils/parseConfig.js +3 -2
- package/dist/utils/parseConfig.js.map +1 -1
- package/dist/utils/version.d.ts +2 -0
- package/dist/utils/version.d.ts.map +1 -0
- package/dist/utils/version.js +3 -0
- package/dist/utils/version.js.map +1 -0
- package/package.json +9 -3
- package/dist/tools/getAccount.d.ts +0 -3
- package/dist/tools/getAccount.d.ts.map +0 -1
- package/dist/tools/getAccount.js +0 -40
- package/dist/tools/getAccount.js.map +0 -1
- package/dist/tools/getCertificate.d.ts +0 -3
- package/dist/tools/getCertificate.d.ts.map +0 -1
- package/dist/tools/getCertificate.js +0 -40
- package/dist/tools/getCertificate.js.map +0 -1
- package/dist/tools/getDeploymentTarget.d.ts +0 -3
- package/dist/tools/getDeploymentTarget.d.ts.map +0 -1
- package/dist/tools/getDeploymentTarget.js +0 -66
- package/dist/tools/getDeploymentTarget.js.map +0 -1
- package/dist/tools/getReleaseById.d.ts +0 -3
- package/dist/tools/getReleaseById.d.ts.map +0 -1
- package/dist/tools/getReleaseById.js +0 -45
- package/dist/tools/getReleaseById.js.map +0 -1
- package/dist/tools/getTaskById.d.ts +0 -9
- package/dist/tools/getTaskById.d.ts.map +0 -1
- package/dist/tools/getTaskById.js +0 -44
- package/dist/tools/getTaskById.js.map +0 -1
- package/dist/tools/getTaskDetails.d.ts +0 -9
- package/dist/tools/getTaskDetails.d.ts.map +0 -1
- package/dist/tools/getTaskDetails.js +0 -44
- package/dist/tools/getTaskDetails.js.map +0 -1
- package/dist/tools/getTaskRaw.d.ts +0 -9
- package/dist/tools/getTaskRaw.d.ts.map +0 -1
- package/dist/tools/getTaskRaw.js +0 -43
- package/dist/tools/getTaskRaw.js.map +0 -1
- package/dist/tools/getTenantById.d.ts +0 -3
- package/dist/tools/getTenantById.d.ts.map +0 -1
- package/dist/tools/getTenantById.js +0 -50
- package/dist/tools/getTenantById.js.map +0 -1
- package/dist/tools/listAccounts.d.ts +0 -3
- package/dist/tools/listAccounts.d.ts.map +0 -1
- package/dist/tools/listAccounts.js +0 -54
- package/dist/tools/listAccounts.js.map +0 -1
- package/dist/tools/listCertificates.d.ts +0 -3
- package/dist/tools/listCertificates.d.ts.map +0 -1
- package/dist/tools/listCertificates.js +0 -62
- package/dist/tools/listCertificates.js.map +0 -1
- package/dist/tools/listDeploymentTargets.d.ts +0 -3
- package/dist/tools/listDeploymentTargets.d.ts.map +0 -1
- package/dist/tools/listDeploymentTargets.js +0 -98
- package/dist/tools/listDeploymentTargets.js.map +0 -1
- package/dist/tools/listReleases.d.ts +0 -3
- package/dist/tools/listReleases.d.ts.map +0 -1
- package/dist/tools/listReleases.js +0 -54
- package/dist/tools/listReleases.js.map +0 -1
- package/dist/tools/listReleasesForProject.d.ts +0 -3
- package/dist/tools/listReleasesForProject.d.ts.map +0 -1
- package/dist/tools/listReleasesForProject.js +0 -60
- package/dist/tools/listReleasesForProject.js.map +0 -1
- package/dist/tools/listTenants.d.ts +0 -3
- package/dist/tools/listTenants.d.ts.map +0 -1
- package/dist/tools/listTenants.js +0 -69
- package/dist/tools/listTenants.js.map +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runRunbook.d.ts","sourceRoot":"","sources":["../../src/tools/runRunbook.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAUzE,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,QA+MvD"}
|
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
import { Client, RunbookRunRepository } from "@octopusdeploy/api-client";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
import {} from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
4
|
+
import { getClientConfigurationFromEnvironment } from "../helpers/getClientConfigurationFromEnvironment.js";
|
|
5
|
+
import { registerToolDefinition } from "../types/toolConfig.js";
|
|
6
|
+
import { DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS } from "../types/toolAnnotations.js";
|
|
7
|
+
import { handleOctopusApiError } from "../helpers/errorHandling.js";
|
|
8
|
+
import { requireConfirmation, unconfirmedResponse, } from "../helpers/requireConfirmation.js";
|
|
9
|
+
export function registerRunRunbookTool(server) {
|
|
10
|
+
server.registerTool("run_runbook", {
|
|
11
|
+
title: "Run a runbook in Octopus Deploy",
|
|
12
|
+
description: `Run a runbook against one or more environments in Octopus Deploy
|
|
13
|
+
|
|
14
|
+
Runbooks execute operational processes (DB backups, smoke tests, environment refresh, etc.) against the specified environments. By default the published snapshot is used; pass runbookSnapshotId to run a specific snapshot. For tenanted runs, supply tenants and/or tenantTags.`,
|
|
15
|
+
inputSchema: {
|
|
16
|
+
spaceName: z.string().describe("The space name"),
|
|
17
|
+
projectName: z.string().describe("The project name"),
|
|
18
|
+
runbookName: z
|
|
19
|
+
.string()
|
|
20
|
+
.describe("The runbook name (within the project)"),
|
|
21
|
+
environmentNames: z
|
|
22
|
+
.array(z.string())
|
|
23
|
+
.min(1)
|
|
24
|
+
.describe("Array of environment names. At least one environment must be provided."),
|
|
25
|
+
tenants: z
|
|
26
|
+
.array(z.string())
|
|
27
|
+
.optional()
|
|
28
|
+
.describe("Array of tenant names for tenanted runs (optional)"),
|
|
29
|
+
tenantTags: z
|
|
30
|
+
.array(z.string())
|
|
31
|
+
.optional()
|
|
32
|
+
.describe("Array of tenant tags for tenanted runs (e.g., ['Region/US-West', 'Tier/Production'])"),
|
|
33
|
+
runbookSnapshotId: z
|
|
34
|
+
.string()
|
|
35
|
+
.optional()
|
|
36
|
+
.describe("Specific snapshot ID. Defaults to the runbook's published snapshot if omitted."),
|
|
37
|
+
promptedVariableValues: z
|
|
38
|
+
.record(z.string())
|
|
39
|
+
.optional()
|
|
40
|
+
.describe("Prompted variable values as key-value pairs"),
|
|
41
|
+
useGuidedFailure: z
|
|
42
|
+
.boolean()
|
|
43
|
+
.optional()
|
|
44
|
+
.describe("Use guided failure mode"),
|
|
45
|
+
forcePackageDownload: z
|
|
46
|
+
.boolean()
|
|
47
|
+
.optional()
|
|
48
|
+
.describe("Force package download"),
|
|
49
|
+
specificMachineNames: z
|
|
50
|
+
.array(z.string())
|
|
51
|
+
.optional()
|
|
52
|
+
.describe("Run on specific machines only"),
|
|
53
|
+
excludedMachineNames: z
|
|
54
|
+
.array(z.string())
|
|
55
|
+
.optional()
|
|
56
|
+
.describe("Exclude specific machines from the run"),
|
|
57
|
+
skipStepNames: z
|
|
58
|
+
.array(z.string())
|
|
59
|
+
.optional()
|
|
60
|
+
.describe("Skip specific runbook steps"),
|
|
61
|
+
runAt: z
|
|
62
|
+
.string()
|
|
63
|
+
.optional()
|
|
64
|
+
.describe("Schedule run for later (ISO 8601 date string)"),
|
|
65
|
+
noRunAfter: z
|
|
66
|
+
.string()
|
|
67
|
+
.optional()
|
|
68
|
+
.describe("Don't run after this time (ISO 8601 date string)"),
|
|
69
|
+
confirm: z
|
|
70
|
+
.boolean()
|
|
71
|
+
.optional()
|
|
72
|
+
.describe("Required only when the MCP client does not support elicitation. Set to true to confirm the run; otherwise the tool aborts."),
|
|
73
|
+
},
|
|
74
|
+
annotations: DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS,
|
|
75
|
+
}, async ({ spaceName, projectName, runbookName, environmentNames, tenants, tenantTags, runbookSnapshotId, promptedVariableValues, useGuidedFailure, forcePackageDownload, specificMachineNames, excludedMachineNames, skipStepNames, runAt, noRunAfter, confirm, }) => {
|
|
76
|
+
try {
|
|
77
|
+
const isTenanted = (tenants && tenants.length > 0) ||
|
|
78
|
+
(tenantTags && tenantTags.length > 0);
|
|
79
|
+
const tenantSummary = isTenanted
|
|
80
|
+
? ` for tenants [${(tenants ?? []).join(", ")}${tenantTags?.length ? `; tags: ${tenantTags.join(", ")}` : ""}]`
|
|
81
|
+
: "";
|
|
82
|
+
const confirmMessage = `Run runbook ${runbookName} of ${projectName} in ` +
|
|
83
|
+
`[${environmentNames.join(", ")}]${tenantSummary} in space ${spaceName}?`;
|
|
84
|
+
const command = {
|
|
85
|
+
spaceName: spaceName,
|
|
86
|
+
ProjectName: projectName,
|
|
87
|
+
RunbookName: runbookName,
|
|
88
|
+
EnvironmentNames: environmentNames,
|
|
89
|
+
...(tenants && { Tenants: tenants }),
|
|
90
|
+
...(tenantTags && { TenantTags: tenantTags }),
|
|
91
|
+
...(runbookSnapshotId && { Snapshot: runbookSnapshotId }),
|
|
92
|
+
...(promptedVariableValues && { Variables: promptedVariableValues }),
|
|
93
|
+
...(useGuidedFailure !== undefined && {
|
|
94
|
+
UseGuidedFailure: useGuidedFailure,
|
|
95
|
+
}),
|
|
96
|
+
...(forcePackageDownload !== undefined && {
|
|
97
|
+
ForcePackageDownload: forcePackageDownload,
|
|
98
|
+
}),
|
|
99
|
+
...(specificMachineNames && {
|
|
100
|
+
SpecificMachineNames: specificMachineNames,
|
|
101
|
+
}),
|
|
102
|
+
...(excludedMachineNames && {
|
|
103
|
+
ExcludedMachineNames: excludedMachineNames,
|
|
104
|
+
}),
|
|
105
|
+
...(skipStepNames && { SkipStepNames: skipStepNames }),
|
|
106
|
+
...(runAt && { RunAt: new Date(runAt) }),
|
|
107
|
+
...(noRunAfter && { NoRunAfter: new Date(noRunAfter) }),
|
|
108
|
+
};
|
|
109
|
+
const confirmation = await requireConfirmation(server, {
|
|
110
|
+
message: confirmMessage,
|
|
111
|
+
fallbackConfirm: confirm,
|
|
112
|
+
change: { source: {}, target: command },
|
|
113
|
+
});
|
|
114
|
+
if (!confirmation.confirmed) {
|
|
115
|
+
return unconfirmedResponse(confirmation, { action: "runbook run" });
|
|
116
|
+
}
|
|
117
|
+
const configuration = getClientConfigurationFromEnvironment();
|
|
118
|
+
const client = await Client.create(configuration);
|
|
119
|
+
const runbookRunRepository = new RunbookRunRepository(client, spaceName);
|
|
120
|
+
const response = await runbookRunRepository.create(command);
|
|
121
|
+
const tasks = response.RunbookRunServerTasks || [];
|
|
122
|
+
const encodedSpace = encodeURIComponent(spaceName);
|
|
123
|
+
return {
|
|
124
|
+
content: [
|
|
125
|
+
{
|
|
126
|
+
type: "text",
|
|
127
|
+
text: JSON.stringify({
|
|
128
|
+
success: true,
|
|
129
|
+
runsCreated: tasks.length,
|
|
130
|
+
runbookRunTasks: tasks.map((task) => ({
|
|
131
|
+
taskId: task.ServerTaskId,
|
|
132
|
+
runbookRunId: task.RunbookRunId,
|
|
133
|
+
resourceUri: `octopus://spaces/${encodedSpace}/tasks/${encodeURIComponent(task.ServerTaskId)}`,
|
|
134
|
+
})),
|
|
135
|
+
message: `Successfully started ${tasks.length} runbook run(s) for ${runbookName}`,
|
|
136
|
+
helpText: `Fetch octopus://spaces/{spaceName}/tasks/{taskId} (or /details for the structured activity tree) via resources/read or read_resource to monitor run progress. To search the raw log for a specific error or step, call grep_task_log with the taskId.`,
|
|
137
|
+
}, null, 2),
|
|
138
|
+
},
|
|
139
|
+
],
|
|
140
|
+
};
|
|
141
|
+
}
|
|
142
|
+
catch (error) {
|
|
143
|
+
if (error instanceof Error && !error.message.includes("octopus")) {
|
|
144
|
+
return {
|
|
145
|
+
content: [
|
|
146
|
+
{
|
|
147
|
+
type: "text",
|
|
148
|
+
text: JSON.stringify({
|
|
149
|
+
success: false,
|
|
150
|
+
error: error.message,
|
|
151
|
+
}, null, 2),
|
|
152
|
+
},
|
|
153
|
+
],
|
|
154
|
+
isError: true,
|
|
155
|
+
};
|
|
156
|
+
}
|
|
157
|
+
handleOctopusApiError(error, {
|
|
158
|
+
entityType: "runbook run",
|
|
159
|
+
spaceName,
|
|
160
|
+
helpText: "Use list_projects to find valid project names, list_environments for environment names, find_tenants for tenant information. Ensure the runbook has a published snapshot (or pass an explicit runbookSnapshotId) and you have permissions to run it.",
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
registerToolDefinition({
|
|
166
|
+
toolName: "run_runbook",
|
|
167
|
+
config: { toolset: "runbooks", readOnly: false },
|
|
168
|
+
registerFn: registerRunRunbookTool,
|
|
169
|
+
// The api-client's RunbookRunRepository.create throws at runtime if the
|
|
170
|
+
// server is older than 2022.3.5512 (the Executions API minimum). Surface
|
|
171
|
+
// that here so --list-tools-by-version reports it accurately.
|
|
172
|
+
minimumOctopusVersion: "2022.3.5512",
|
|
173
|
+
});
|
|
174
|
+
//# sourceMappingURL=runRunbook.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"runRunbook.js","sourceRoot":"","sources":["../../src/tools/runRunbook.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACzE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAkB,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,qCAAqC,EAAE,MAAM,qDAAqD,CAAC;AAC5G,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,kCAAkC,EAAE,MAAM,6BAA6B,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EACL,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,mCAAmC,CAAC;AAE3C,MAAM,UAAU,sBAAsB,CAAC,MAAiB;IACtD,MAAM,CAAC,YAAY,CACjB,aAAa,EACb;QACE,KAAK,EAAE,iCAAiC;QACxC,WAAW,EAAE;;mRAEgQ;QAC7Q,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAChD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YACpD,WAAW,EAAE,CAAC;iBACX,MAAM,EAAE;iBACR,QAAQ,CAAC,uCAAuC,CAAC;YACpD,gBAAgB,EAAE,CAAC;iBAChB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,GAAG,CAAC,CAAC,CAAC;iBACN,QAAQ,CACP,wEAAwE,CACzE;YACH,OAAO,EAAE,CAAC;iBACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,oDAAoD,CAAC;YACjE,UAAU,EAAE,CAAC;iBACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CACP,sFAAsF,CACvF;YACH,iBAAiB,EAAE,CAAC;iBACjB,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,gFAAgF,CACjF;YACH,sBAAsB,EAAE,CAAC;iBACtB,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBAClB,QAAQ,EAAE;iBACV,QAAQ,CAAC,6CAA6C,CAAC;YAC1D,gBAAgB,EAAE,CAAC;iBAChB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,yBAAyB,CAAC;YACtC,oBAAoB,EAAE,CAAC;iBACpB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,wBAAwB,CAAC;YACrC,oBAAoB,EAAE,CAAC;iBACpB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,+BAA+B,CAAC;YAC5C,oBAAoB,EAAE,CAAC;iBACpB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,wCAAwC,CAAC;YACrD,aAAa,EAAE,CAAC;iBACb,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,6BAA6B,CAAC;YAC1C,KAAK,EAAE,CAAC;iBACL,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,+CAA+C,CAAC;YAC5D,UAAU,EAAE,CAAC;iBACV,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,kDAAkD,CAAC;YAC/D,OAAO,EAAE,CAAC;iBACP,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CACP,4HAA4H,CAC7H;SACJ;QACD,WAAW,EAAE,kCAAkC;KAChD,EACD,KAAK,EAAE,EACL,SAAS,EACT,WAAW,EACX,WAAW,EACX,gBAAgB,EAChB,OAAO,EACP,UAAU,EACV,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,aAAa,EACb,KAAK,EACL,UAAU,EACV,OAAO,GACR,EAAE,EAAE;QACH,IAAI,CAAC;YACH,MAAM,UAAU,GACd,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC/B,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAExC,MAAM,aAAa,GAAG,UAAU;gBAC9B,CAAC,CAAC,iBAAiB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GACzC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,WAAW,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAC5D,GAAG;gBACL,CAAC,CAAC,EAAE,CAAC;YACP,MAAM,cAAc,GAClB,eAAe,WAAW,OAAO,WAAW,MAAM;gBAClD,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,aAAa,SAAS,GAAG,CAAC;YAE5E,MAAM,OAAO,GAAG;gBACd,SAAS,EAAE,SAAS;gBACpB,WAAW,EAAE,WAAW;gBACxB,WAAW,EAAE,WAAW;gBACxB,gBAAgB,EAAE,gBAAgB;gBAClC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;gBACpC,GAAG,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;gBAC7C,GAAG,CAAC,iBAAiB,IAAI,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC;gBACzD,GAAG,CAAC,sBAAsB,IAAI,EAAE,SAAS,EAAE,sBAAsB,EAAE,CAAC;gBACpE,GAAG,CAAC,gBAAgB,KAAK,SAAS,IAAI;oBACpC,gBAAgB,EAAE,gBAAgB;iBACnC,CAAC;gBACF,GAAG,CAAC,oBAAoB,KAAK,SAAS,IAAI;oBACxC,oBAAoB,EAAE,oBAAoB;iBAC3C,CAAC;gBACF,GAAG,CAAC,oBAAoB,IAAI;oBAC1B,oBAAoB,EAAE,oBAAoB;iBAC3C,CAAC;gBACF,GAAG,CAAC,oBAAoB,IAAI;oBAC1B,oBAAoB,EAAE,oBAAoB;iBAC3C,CAAC;gBACF,GAAG,CAAC,aAAa,IAAI,EAAE,aAAa,EAAE,aAAa,EAAE,CAAC;gBACtD,GAAG,CAAC,KAAK,IAAI,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACxC,GAAG,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;aACxD,CAAC;YAEF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;gBACrD,OAAO,EAAE,cAAc;gBACvB,eAAe,EAAE,OAAO;gBACxB,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;aACxC,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;gBAC5B,OAAO,mBAAmB,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;YACtE,CAAC;YAED,MAAM,aAAa,GAAG,qCAAqC,EAAE,CAAC;YAC9D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;YAClD,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,CACnD,MAAM,EACN,SAAS,CACV,CAAC;YAEF,MAAM,QAAQ,GAAG,MAAM,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAE5D,MAAM,KAAK,GAAG,QAAQ,CAAC,qBAAqB,IAAI,EAAE,CAAC;YACnD,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;YAEnD,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;4BACE,OAAO,EAAE,IAAI;4BACb,WAAW,EAAE,KAAK,CAAC,MAAM;4BACzB,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gCACpC,MAAM,EAAE,IAAI,CAAC,YAAY;gCACzB,YAAY,EAAE,IAAI,CAAC,YAAY;gCAC/B,WAAW,EAAE,oBAAoB,YAAY,UAAU,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;6BAC/F,CAAC,CAAC;4BACH,OAAO,EAAE,wBAAwB,KAAK,CAAC,MAAM,uBAAuB,WAAW,EAAE;4BACjF,QAAQ,EAAE,uPAAuP;yBAClQ,EACD,IAAI,EACJ,CAAC,CACF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjE,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;gCACE,OAAO,EAAE,KAAK;gCACd,KAAK,EAAE,KAAK,CAAC,OAAO;6BACrB,EACD,IAAI,EACJ,CAAC,CACF;yBACF;qBACF;oBACD,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;YAED,qBAAqB,CAAC,KAAK,EAAE;gBAC3B,UAAU,EAAE,aAAa;gBACzB,SAAS;gBACT,QAAQ,EACN,sPAAsP;aACzP,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED,sBAAsB,CAAC;IACrB,QAAQ,EAAE,aAAa;IACvB,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE;IAChD,UAAU,EAAE,sBAAsB;IAClC,wEAAwE;IACxE,yEAAyE;IACzE,8DAA8D;IAC9D,qBAAqB,EAAE,aAAa;CACrC,CAAC,CAAC"}
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
import { type McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
|
+
export declare const updateFeatureToggleSchema: z.ZodEffects<z.ZodObject<{
|
|
4
|
+
spaceName: z.ZodString;
|
|
5
|
+
projectId: z.ZodString;
|
|
6
|
+
slug: z.ZodString;
|
|
7
|
+
defaultIsEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
8
|
+
description: z.ZodOptional<z.ZodString>;
|
|
9
|
+
environments: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
10
|
+
deploymentEnvironmentId: z.ZodString;
|
|
11
|
+
isEnabled: z.ZodOptional<z.ZodBoolean>;
|
|
12
|
+
rolloutPercentage: z.ZodOptional<z.ZodNumber>;
|
|
13
|
+
clientRolloutPercentage: z.ZodOptional<z.ZodNumber>;
|
|
14
|
+
}, "strip", z.ZodTypeAny, {
|
|
15
|
+
deploymentEnvironmentId: string;
|
|
16
|
+
isEnabled?: boolean | undefined;
|
|
17
|
+
rolloutPercentage?: number | undefined;
|
|
18
|
+
clientRolloutPercentage?: number | undefined;
|
|
19
|
+
}, {
|
|
20
|
+
deploymentEnvironmentId: string;
|
|
21
|
+
isEnabled?: boolean | undefined;
|
|
22
|
+
rolloutPercentage?: number | undefined;
|
|
23
|
+
clientRolloutPercentage?: number | undefined;
|
|
24
|
+
}>, "many">>;
|
|
25
|
+
confirm: z.ZodOptional<z.ZodBoolean>;
|
|
26
|
+
}, "strip", z.ZodTypeAny, {
|
|
27
|
+
spaceName: string;
|
|
28
|
+
projectId: string;
|
|
29
|
+
slug: string;
|
|
30
|
+
description?: string | undefined;
|
|
31
|
+
environments?: {
|
|
32
|
+
deploymentEnvironmentId: string;
|
|
33
|
+
isEnabled?: boolean | undefined;
|
|
34
|
+
rolloutPercentage?: number | undefined;
|
|
35
|
+
clientRolloutPercentage?: number | undefined;
|
|
36
|
+
}[] | undefined;
|
|
37
|
+
defaultIsEnabled?: boolean | undefined;
|
|
38
|
+
confirm?: boolean | undefined;
|
|
39
|
+
}, {
|
|
40
|
+
spaceName: string;
|
|
41
|
+
projectId: string;
|
|
42
|
+
slug: string;
|
|
43
|
+
description?: string | undefined;
|
|
44
|
+
environments?: {
|
|
45
|
+
deploymentEnvironmentId: string;
|
|
46
|
+
isEnabled?: boolean | undefined;
|
|
47
|
+
rolloutPercentage?: number | undefined;
|
|
48
|
+
clientRolloutPercentage?: number | undefined;
|
|
49
|
+
}[] | undefined;
|
|
50
|
+
defaultIsEnabled?: boolean | undefined;
|
|
51
|
+
confirm?: boolean | undefined;
|
|
52
|
+
}>, {
|
|
53
|
+
spaceName: string;
|
|
54
|
+
projectId: string;
|
|
55
|
+
slug: string;
|
|
56
|
+
description?: string | undefined;
|
|
57
|
+
environments?: {
|
|
58
|
+
deploymentEnvironmentId: string;
|
|
59
|
+
isEnabled?: boolean | undefined;
|
|
60
|
+
rolloutPercentage?: number | undefined;
|
|
61
|
+
clientRolloutPercentage?: number | undefined;
|
|
62
|
+
}[] | undefined;
|
|
63
|
+
defaultIsEnabled?: boolean | undefined;
|
|
64
|
+
confirm?: boolean | undefined;
|
|
65
|
+
}, {
|
|
66
|
+
spaceName: string;
|
|
67
|
+
projectId: string;
|
|
68
|
+
slug: string;
|
|
69
|
+
description?: string | undefined;
|
|
70
|
+
environments?: {
|
|
71
|
+
deploymentEnvironmentId: string;
|
|
72
|
+
isEnabled?: boolean | undefined;
|
|
73
|
+
rolloutPercentage?: number | undefined;
|
|
74
|
+
clientRolloutPercentage?: number | undefined;
|
|
75
|
+
}[] | undefined;
|
|
76
|
+
defaultIsEnabled?: boolean | undefined;
|
|
77
|
+
confirm?: boolean | undefined;
|
|
78
|
+
}>;
|
|
79
|
+
export type UpdateFeatureToggleParams = z.infer<typeof updateFeatureToggleSchema>;
|
|
80
|
+
export declare function updateFeatureToggleHandler(server: McpServer, params: UpdateFeatureToggleParams): Promise<{
|
|
81
|
+
content: {
|
|
82
|
+
type: "text";
|
|
83
|
+
text: string;
|
|
84
|
+
}[];
|
|
85
|
+
isError: boolean;
|
|
86
|
+
} | {
|
|
87
|
+
content: {
|
|
88
|
+
type: "text";
|
|
89
|
+
text: string;
|
|
90
|
+
}[];
|
|
91
|
+
isError?: undefined;
|
|
92
|
+
}>;
|
|
93
|
+
export declare function registerUpdateFeatureToggleTool(server: McpServer): void;
|
|
94
|
+
//# sourceMappingURL=updateFeatureToggle.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"updateFeatureToggle.d.ts","sourceRoot":"","sources":["../../src/tools/updateFeatureToggle.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAwCzE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDlC,CAAC;AAEL,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAoFlF,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,yBAAyB;;;;;;;;;;;;GAkMlC;AAED,wBAAgB,+BAA+B,CAAC,MAAM,EAAE,SAAS,QAiBhE"}
|
|
@@ -0,0 +1,308 @@
|
|
|
1
|
+
import { Client, resolveSpaceId } from "@octopusdeploy/api-client";
|
|
2
|
+
import { z } from "zod";
|
|
3
|
+
import {} from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
4
|
+
import { getClientConfigurationFromEnvironment } from "../helpers/getClientConfigurationFromEnvironment.js";
|
|
5
|
+
import { registerToolDefinition } from "../types/toolConfig.js";
|
|
6
|
+
import { DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS } from "../types/toolAnnotations.js";
|
|
7
|
+
import { handleOctopusApiError } from "../helpers/errorHandling.js";
|
|
8
|
+
import { requireConfirmation, unconfirmedResponse, } from "../helpers/requireConfirmation.js";
|
|
9
|
+
import {} from "../types/featureToggleTypes.js";
|
|
10
|
+
const environmentPatchSchema = z.object({
|
|
11
|
+
deploymentEnvironmentId: z
|
|
12
|
+
.string()
|
|
13
|
+
.describe("Targets the existing per-environment configuration to patch (e.g. Environments-7). Must already be configured on the toggle — this tool does not add new environment configurations."),
|
|
14
|
+
isEnabled: z
|
|
15
|
+
.boolean()
|
|
16
|
+
.optional()
|
|
17
|
+
.describe("Whether the toggle is on for this environment, before targeting/rollout is applied."),
|
|
18
|
+
rolloutPercentage: z
|
|
19
|
+
.number()
|
|
20
|
+
.int()
|
|
21
|
+
.min(0)
|
|
22
|
+
.max(100)
|
|
23
|
+
.optional()
|
|
24
|
+
.describe("Server-side rollout percentage [0, 100]."),
|
|
25
|
+
clientRolloutPercentage: z
|
|
26
|
+
.number()
|
|
27
|
+
.int()
|
|
28
|
+
.min(0)
|
|
29
|
+
.max(100)
|
|
30
|
+
.optional()
|
|
31
|
+
.describe("Client-side fractional rollout evaluated by the SDK [0, 100]."),
|
|
32
|
+
});
|
|
33
|
+
export const updateFeatureToggleSchema = z
|
|
34
|
+
.object({
|
|
35
|
+
spaceName: z.string().describe("Space name."),
|
|
36
|
+
projectId: z
|
|
37
|
+
.string()
|
|
38
|
+
.describe("Project ID (e.g. Projects-123). Feature toggles are scoped per project."),
|
|
39
|
+
slug: z
|
|
40
|
+
.string()
|
|
41
|
+
.describe("The toggle's Slug (not its Id). Find it via find_feature_toggles."),
|
|
42
|
+
defaultIsEnabled: z
|
|
43
|
+
.boolean()
|
|
44
|
+
.optional()
|
|
45
|
+
.describe("Toggle-level default. The value returned for environments that have no explicit per-environment configuration."),
|
|
46
|
+
description: z
|
|
47
|
+
.string()
|
|
48
|
+
.optional()
|
|
49
|
+
.describe("Toggle-level description (max 1000 chars). Markdown supported in the UI."),
|
|
50
|
+
environments: z
|
|
51
|
+
.array(environmentPatchSchema)
|
|
52
|
+
.optional()
|
|
53
|
+
.describe("Per-environment patches. Environments not listed here are preserved as-is. Each entry must reference a deploymentEnvironmentId that already exists on the toggle; unknown environments are rejected rather than silently added. Each environment may appear at most once in this array — duplicates are rejected."),
|
|
54
|
+
confirm: z
|
|
55
|
+
.boolean()
|
|
56
|
+
.optional()
|
|
57
|
+
.describe("Required only when the MCP client does not support elicitation. Set to true to confirm the update; otherwise the tool aborts."),
|
|
58
|
+
})
|
|
59
|
+
.superRefine((args, ctx) => {
|
|
60
|
+
// Reject duplicate deploymentEnvironmentIds up front. Without this,
|
|
61
|
+
// the merge picks the FIRST patch for the env while the confirmation
|
|
62
|
+
// diff overwrites earlier entries with later ones using the same key —
|
|
63
|
+
// the user could see one change in the prompt and a different one
|
|
64
|
+
// actually go through.
|
|
65
|
+
if (!args.environments)
|
|
66
|
+
return;
|
|
67
|
+
const seen = new Map();
|
|
68
|
+
for (let i = 0; i < args.environments.length; i++) {
|
|
69
|
+
const id = args.environments[i].deploymentEnvironmentId;
|
|
70
|
+
const prev = seen.get(id);
|
|
71
|
+
if (prev !== undefined) {
|
|
72
|
+
ctx.addIssue({
|
|
73
|
+
code: z.ZodIssueCode.custom,
|
|
74
|
+
message: `Duplicate environment entry for '${id}' at index ${i} (also at index ${prev}). ` +
|
|
75
|
+
"Combine the patches into a single entry per environment.",
|
|
76
|
+
path: ["environments", i, "deploymentEnvironmentId"],
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
seen.set(id, i);
|
|
80
|
+
}
|
|
81
|
+
});
|
|
82
|
+
function applyEnvironmentPatch(current, patch) {
|
|
83
|
+
const merged = { ...current };
|
|
84
|
+
const changedFields = [];
|
|
85
|
+
if (patch.isEnabled !== undefined && patch.isEnabled !== current.IsEnabled) {
|
|
86
|
+
merged.IsEnabled = patch.isEnabled;
|
|
87
|
+
changedFields.push("IsEnabled");
|
|
88
|
+
}
|
|
89
|
+
if (patch.rolloutPercentage !== undefined &&
|
|
90
|
+
patch.rolloutPercentage !== current.RolloutPercentage) {
|
|
91
|
+
merged.RolloutPercentage = patch.rolloutPercentage;
|
|
92
|
+
changedFields.push("RolloutPercentage");
|
|
93
|
+
}
|
|
94
|
+
if (patch.clientRolloutPercentage !== undefined &&
|
|
95
|
+
patch.clientRolloutPercentage !== current.ClientRolloutPercentage) {
|
|
96
|
+
merged.ClientRolloutPercentage = patch.clientRolloutPercentage;
|
|
97
|
+
changedFields.push("ClientRolloutPercentage");
|
|
98
|
+
}
|
|
99
|
+
return { current, merged, changedFields };
|
|
100
|
+
}
|
|
101
|
+
function buildDiffSource(toggle, params, envPatches) {
|
|
102
|
+
const source = {};
|
|
103
|
+
if (params.defaultIsEnabled !== undefined) {
|
|
104
|
+
source.DefaultIsEnabled = toggle.DefaultIsEnabled;
|
|
105
|
+
}
|
|
106
|
+
if (params.description !== undefined) {
|
|
107
|
+
source.Description = toggle.Description ?? null;
|
|
108
|
+
}
|
|
109
|
+
for (const patch of envPatches) {
|
|
110
|
+
if (patch.changedFields.length === 0)
|
|
111
|
+
continue;
|
|
112
|
+
const sourceFields = {};
|
|
113
|
+
for (const field of patch.changedFields) {
|
|
114
|
+
sourceFields[field] =
|
|
115
|
+
patch.current[field];
|
|
116
|
+
}
|
|
117
|
+
source[`Environments[${patch.current.DeploymentEnvironmentId}]`] = sourceFields;
|
|
118
|
+
}
|
|
119
|
+
return source;
|
|
120
|
+
}
|
|
121
|
+
function buildDiffTarget(params, envPatches) {
|
|
122
|
+
const target = {};
|
|
123
|
+
if (params.defaultIsEnabled !== undefined) {
|
|
124
|
+
target.DefaultIsEnabled = params.defaultIsEnabled;
|
|
125
|
+
}
|
|
126
|
+
if (params.description !== undefined) {
|
|
127
|
+
target.Description = params.description;
|
|
128
|
+
}
|
|
129
|
+
for (const patch of envPatches) {
|
|
130
|
+
if (patch.changedFields.length === 0)
|
|
131
|
+
continue;
|
|
132
|
+
const targetFields = {};
|
|
133
|
+
for (const field of patch.changedFields) {
|
|
134
|
+
targetFields[field] =
|
|
135
|
+
patch.merged[field];
|
|
136
|
+
}
|
|
137
|
+
target[`Environments[${patch.current.DeploymentEnvironmentId}]`] = targetFields;
|
|
138
|
+
}
|
|
139
|
+
return target;
|
|
140
|
+
}
|
|
141
|
+
export async function updateFeatureToggleHandler(server, params) {
|
|
142
|
+
const { spaceName, projectId, slug, environments, confirm } = params;
|
|
143
|
+
const noPatches = params.defaultIsEnabled === undefined &&
|
|
144
|
+
params.description === undefined &&
|
|
145
|
+
(!environments || environments.length === 0);
|
|
146
|
+
if (noPatches) {
|
|
147
|
+
return {
|
|
148
|
+
content: [
|
|
149
|
+
{
|
|
150
|
+
type: "text",
|
|
151
|
+
text: JSON.stringify({
|
|
152
|
+
success: false,
|
|
153
|
+
reason: "no_patches",
|
|
154
|
+
message: "No fields supplied to update. Pass at least one of defaultIsEnabled, description, or environments[].",
|
|
155
|
+
}, null, 2),
|
|
156
|
+
},
|
|
157
|
+
],
|
|
158
|
+
isError: true,
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
const client = await Client.create(getClientConfigurationFromEnvironment());
|
|
162
|
+
let spaceId;
|
|
163
|
+
try {
|
|
164
|
+
spaceId = await resolveSpaceId(client, spaceName);
|
|
165
|
+
}
|
|
166
|
+
catch (error) {
|
|
167
|
+
handleOctopusApiError(error, { spaceName });
|
|
168
|
+
}
|
|
169
|
+
let current;
|
|
170
|
+
try {
|
|
171
|
+
current = await client.get("~/api/{spaceId}/projects/{projectId}/featuretoggles/{slug}", { spaceId, projectId, slug });
|
|
172
|
+
}
|
|
173
|
+
catch (error) {
|
|
174
|
+
handleOctopusApiError(error, {
|
|
175
|
+
entityType: "feature toggle",
|
|
176
|
+
entityId: slug,
|
|
177
|
+
spaceName,
|
|
178
|
+
helpText: "Use find_feature_toggles to list valid slugs. If 404 persists across all toggles in the project, the customer feature toggles capability may be disabled on the Octopus instance.",
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
// Match patch entries to existing environment configurations. Unknown
|
|
182
|
+
// environments are rejected — the contract is "slight adjustment", not
|
|
183
|
+
// "configure new environments".
|
|
184
|
+
const envPatches = [];
|
|
185
|
+
if (environments) {
|
|
186
|
+
for (const patch of environments) {
|
|
187
|
+
const existing = current.Environments.find((e) => e.DeploymentEnvironmentId === patch.deploymentEnvironmentId);
|
|
188
|
+
if (!existing) {
|
|
189
|
+
const configured = current.Environments.map((e) => e.DeploymentEnvironmentId);
|
|
190
|
+
return {
|
|
191
|
+
content: [
|
|
192
|
+
{
|
|
193
|
+
type: "text",
|
|
194
|
+
text: JSON.stringify({
|
|
195
|
+
success: false,
|
|
196
|
+
reason: "environment_not_configured",
|
|
197
|
+
message: `Environment '${patch.deploymentEnvironmentId}' is not configured on toggle '${current.Slug}'. ` +
|
|
198
|
+
"This tool only adjusts existing environment configurations; it does not add new ones. " +
|
|
199
|
+
"Use the Octopus UI to add an environment to a toggle.",
|
|
200
|
+
configuredEnvironmentIds: configured,
|
|
201
|
+
}, null, 2),
|
|
202
|
+
},
|
|
203
|
+
],
|
|
204
|
+
isError: true,
|
|
205
|
+
};
|
|
206
|
+
}
|
|
207
|
+
envPatches.push(applyEnvironmentPatch(existing, patch));
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
// Detect a no-op call (everything provided already matches current state)
|
|
211
|
+
// before involving the user with a confirmation dialog.
|
|
212
|
+
const toggleLevelChanges = (params.defaultIsEnabled !== undefined &&
|
|
213
|
+
params.defaultIsEnabled !== current.DefaultIsEnabled) ||
|
|
214
|
+
(params.description !== undefined &&
|
|
215
|
+
params.description !== (current.Description ?? undefined));
|
|
216
|
+
const envLevelChanges = envPatches.some((p) => p.changedFields.length > 0);
|
|
217
|
+
if (!toggleLevelChanges && !envLevelChanges) {
|
|
218
|
+
return {
|
|
219
|
+
content: [
|
|
220
|
+
{
|
|
221
|
+
type: "text",
|
|
222
|
+
text: JSON.stringify({
|
|
223
|
+
success: true,
|
|
224
|
+
noOp: true,
|
|
225
|
+
message: "All supplied fields already match the current toggle state — nothing to update.",
|
|
226
|
+
slug: current.Slug,
|
|
227
|
+
}, null, 2),
|
|
228
|
+
},
|
|
229
|
+
],
|
|
230
|
+
};
|
|
231
|
+
}
|
|
232
|
+
const merged = {
|
|
233
|
+
...current,
|
|
234
|
+
DefaultIsEnabled: params.defaultIsEnabled !== undefined
|
|
235
|
+
? params.defaultIsEnabled
|
|
236
|
+
: current.DefaultIsEnabled,
|
|
237
|
+
Description: params.description !== undefined ? params.description : current.Description,
|
|
238
|
+
Environments: current.Environments.map((env) => {
|
|
239
|
+
const patch = envPatches.find((p) => p.current.DeploymentEnvironmentId === env.DeploymentEnvironmentId);
|
|
240
|
+
return patch ? patch.merged : env;
|
|
241
|
+
}),
|
|
242
|
+
};
|
|
243
|
+
const confirmation = await requireConfirmation(server, {
|
|
244
|
+
message: `Update feature toggle "${current.Name}" (${current.Slug}) in space ${spaceName}?`,
|
|
245
|
+
fallbackConfirm: confirm,
|
|
246
|
+
change: {
|
|
247
|
+
source: buildDiffSource(current, params, envPatches),
|
|
248
|
+
target: buildDiffTarget(params, envPatches),
|
|
249
|
+
},
|
|
250
|
+
});
|
|
251
|
+
if (!confirmation.confirmed) {
|
|
252
|
+
return unconfirmedResponse(confirmation, {
|
|
253
|
+
action: "feature toggle update",
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
try {
|
|
257
|
+
await client.doUpdate("~/api/{spaceId}/projects/{projectId}/featuretoggles", merged, { spaceId, projectId });
|
|
258
|
+
}
|
|
259
|
+
catch (error) {
|
|
260
|
+
handleOctopusApiError(error, {
|
|
261
|
+
entityType: "feature toggle",
|
|
262
|
+
entityId: current.Id,
|
|
263
|
+
spaceName,
|
|
264
|
+
helpText: "Verify you have FeatureToggleEdit on the project and every environment referenced. Server-side validation rules (max segments, ephemeral environment clamping, etc.) are documented in the Octopus feature toggles API reference.",
|
|
265
|
+
});
|
|
266
|
+
}
|
|
267
|
+
const encodedSpace = encodeURIComponent(spaceName);
|
|
268
|
+
const encodedProjectId = encodeURIComponent(projectId);
|
|
269
|
+
const encodedSlug = encodeURIComponent(current.Slug);
|
|
270
|
+
const resourceUri = `octopus://spaces/${encodedSpace}/projects/${encodedProjectId}/featuretoggles/${encodedSlug}`;
|
|
271
|
+
return {
|
|
272
|
+
content: [
|
|
273
|
+
{
|
|
274
|
+
type: "text",
|
|
275
|
+
text: JSON.stringify({
|
|
276
|
+
success: true,
|
|
277
|
+
id: current.Id,
|
|
278
|
+
slug: current.Slug,
|
|
279
|
+
name: current.Name,
|
|
280
|
+
resourceUri,
|
|
281
|
+
message: `Feature toggle '${current.Slug}' updated successfully.`,
|
|
282
|
+
helpText: "Dereference resourceUri to read the updated toggle body.",
|
|
283
|
+
}, null, 2),
|
|
284
|
+
},
|
|
285
|
+
],
|
|
286
|
+
};
|
|
287
|
+
}
|
|
288
|
+
export function registerUpdateFeatureToggleTool(server) {
|
|
289
|
+
server.registerTool("update_feature_toggle", {
|
|
290
|
+
title: "Update a feature toggle",
|
|
291
|
+
description: `Adjust an existing customer feature toggle in an Octopus Deploy project.
|
|
292
|
+
|
|
293
|
+
Narrow surface — flip an environment on/off, change rollout percentages, or update the toggle-level description / default state. Internally fetches the current toggle, applies your patches in memory, and PUTs the merged body, so unmentioned environments and unmentioned fields are preserved.
|
|
294
|
+
|
|
295
|
+
Deliberately not exposed: name/slug rename, tag changes, rollout group attach/detach, tenant targeting, segments, minimum version, adding or removing environment configurations entirely. For those, use the Octopus UI.
|
|
296
|
+
|
|
297
|
+
Patches that reference an environment not already configured on the toggle are rejected with reason: environment_not_configured. The tool does not add new environment configurations.`,
|
|
298
|
+
inputSchema: updateFeatureToggleSchema,
|
|
299
|
+
annotations: DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS,
|
|
300
|
+
}, (args) => updateFeatureToggleHandler(server, args));
|
|
301
|
+
}
|
|
302
|
+
registerToolDefinition({
|
|
303
|
+
toolName: "update_feature_toggle",
|
|
304
|
+
config: { toolset: "featureToggles", readOnly: false },
|
|
305
|
+
registerFn: registerUpdateFeatureToggleTool,
|
|
306
|
+
minimumOctopusVersion: "2026.1.10655",
|
|
307
|
+
});
|
|
308
|
+
//# sourceMappingURL=updateFeatureToggle.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"updateFeatureToggle.js","sourceRoot":"","sources":["../../src/tools/updateFeatureToggle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAkB,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,qCAAqC,EAAE,MAAM,qDAAqD,CAAC;AAC5G,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,kCAAkC,EAAE,MAAM,6BAA6B,CAAC;AACjF,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EACL,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAGN,MAAM,gCAAgC,CAAC;AAExC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,uBAAuB,EAAE,CAAC;SACvB,MAAM,EAAE;SACR,QAAQ,CACP,sLAAsL,CACvL;IACH,SAAS,EAAE,CAAC;SACT,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,qFAAqF,CAAC;IAClG,iBAAiB,EAAE,CAAC;SACjB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0CAA0C,CAAC;IACvD,uBAAuB,EAAE,CAAC;SACvB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,+DAA+D,CAAC;CAC7E,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC;IAC7C,SAAS,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,CAAC,yEAAyE,CAAC;IACtF,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CAAC,mEAAmE,CAAC;IAChF,gBAAgB,EAAE,CAAC;SAChB,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,gHAAgH,CACjH;IACH,WAAW,EAAE,CAAC;SACX,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,0EAA0E,CAAC;IACvF,YAAY,EAAE,CAAC;SACZ,KAAK,CAAC,sBAAsB,CAAC;SAC7B,QAAQ,EAAE;SACV,QAAQ,CACP,mTAAmT,CACpT;IACH,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,+HAA+H,CAChI;CACJ,CAAC;KACD,WAAW,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;IACzB,oEAAoE;IACpE,qEAAqE;IACrE,uEAAuE;IACvE,kEAAkE;IAClE,uBAAuB;IACvB,IAAI,CAAC,IAAI,CAAC,YAAY;QAAE,OAAO;IAC/B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAClD,MAAM,EAAE,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,GAAG,CAAC,QAAQ,CAAC;gBACX,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,MAAM;gBAC3B,OAAO,EACL,oCAAoC,EAAE,cAAc,CAAC,mBAAmB,IAAI,KAAK;oBACjF,0DAA0D;gBAC5D,IAAI,EAAE,CAAC,cAAc,EAAE,CAAC,EAAE,yBAAyB,CAAC;aACrD,CAAC,CAAC;QACL,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,CAAC;AAUL,SAAS,qBAAqB,CAC5B,OAAyC,EACzC,KAA6C;IAE7C,MAAM,MAAM,GAAqC,EAAE,GAAG,OAAO,EAAE,CAAC;IAChE,MAAM,aAAa,GAAa,EAAE,CAAC;IAEnC,IAAI,KAAK,CAAC,SAAS,KAAK,SAAS,IAAI,KAAK,CAAC,SAAS,KAAK,OAAO,CAAC,SAAS,EAAE,CAAC;QAC3E,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QACnC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IACD,IACE,KAAK,CAAC,iBAAiB,KAAK,SAAS;QACrC,KAAK,CAAC,iBAAiB,KAAK,OAAO,CAAC,iBAAiB,EACrD,CAAC;QACD,MAAM,CAAC,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QACnD,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC1C,CAAC;IACD,IACE,KAAK,CAAC,uBAAuB,KAAK,SAAS;QAC3C,KAAK,CAAC,uBAAuB,KAAK,OAAO,CAAC,uBAAuB,EACjE,CAAC;QACD,MAAM,CAAC,uBAAuB,GAAG,KAAK,CAAC,uBAAuB,CAAC;QAC/D,aAAa,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;AAC5C,CAAC;AAED,SAAS,eAAe,CACtB,MAA6B,EAC7B,MAAiC,EACjC,UAAgC;IAEhC,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC1C,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;IACpD,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,IAAI,CAAC;IAClD,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAC/C,MAAM,YAAY,GAA4B,EAAE,CAAC;QACjD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxC,YAAY,CAAC,KAAK,CAAC;gBACjB,KAAK,CAAC,OAAO,CAAC,KAA+C,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,CAAC,gBAAgB,KAAK,CAAC,OAAO,CAAC,uBAAuB,GAAG,CAAC,GAAG,YAAY,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CACtB,MAAiC,EACjC,UAAgC;IAEhC,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;QAC1C,MAAM,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;IACpD,CAAC;IACD,IAAI,MAAM,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACrC,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;IAC1C,CAAC;IACD,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAC/B,IAAI,KAAK,CAAC,aAAa,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAC/C,MAAM,YAAY,GAA4B,EAAE,CAAC;QACjD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxC,YAAY,CAAC,KAAK,CAAC;gBACjB,KAAK,CAAC,MAAM,CAAC,KAA+C,CAAC,CAAC;QAClE,CAAC;QACD,MAAM,CAAC,gBAAgB,KAAK,CAAC,OAAO,CAAC,uBAAuB,GAAG,CAAC,GAAG,YAAY,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,MAAiB,EACjB,MAAiC;IAEjC,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAErE,MAAM,SAAS,GACb,MAAM,CAAC,gBAAgB,KAAK,SAAS;QACrC,MAAM,CAAC,WAAW,KAAK,SAAS;QAChC,CAAC,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;IAC/C,IAAI,SAAS,EAAE,CAAC;QACd,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;wBACE,OAAO,EAAE,KAAK;wBACd,MAAM,EAAE,YAAY;wBACpB,OAAO,EACL,sGAAsG;qBACzG,EACD,IAAI,EACJ,CAAC,CACF;iBACF;aACF;YACD,OAAO,EAAE,IAAI;SACd,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,qCAAqC,EAAE,CAAC,CAAC;IAE5E,IAAI,OAAe,CAAC;IACpB,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,qBAAqB,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,IAAI,OAA8B,CAAC;IACnC,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,MAAM,CAAC,GAAG,CACxB,4DAA4D,EAC5D,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAC7B,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,qBAAqB,CAAC,KAAK,EAAE;YAC3B,UAAU,EAAE,gBAAgB;YAC5B,QAAQ,EAAE,IAAI;YACd,SAAS;YACT,QAAQ,EACN,mLAAmL;SACtL,CAAC,CAAC;IACL,CAAC;IAED,sEAAsE;IACtE,uEAAuE;IACvE,gCAAgC;IAChC,MAAM,UAAU,GAAyB,EAAE,CAAC;IAC5C,IAAI,YAAY,EAAE,CAAC;QACjB,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CACxC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,KAAK,KAAK,CAAC,uBAAuB,CACnE,CAAC;YACF,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,UAAU,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,CACzC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CACjC,CAAC;gBACF,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAe;4BACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;gCACE,OAAO,EAAE,KAAK;gCACd,MAAM,EAAE,4BAA4B;gCACpC,OAAO,EACL,gBAAgB,KAAK,CAAC,uBAAuB,kCAAkC,OAAO,CAAC,IAAI,KAAK;oCAChG,wFAAwF;oCACxF,uDAAuD;gCACzD,wBAAwB,EAAE,UAAU;6BACrC,EACD,IAAI,EACJ,CAAC,CACF;yBACF;qBACF;oBACD,OAAO,EAAE,IAAI;iBACd,CAAC;YACJ,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED,0EAA0E;IAC1E,wDAAwD;IACxD,MAAM,kBAAkB,GACtB,CAAC,MAAM,CAAC,gBAAgB,KAAK,SAAS;QACpC,MAAM,CAAC,gBAAgB,KAAK,OAAO,CAAC,gBAAgB,CAAC;QACvD,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS;YAC/B,MAAM,CAAC,WAAW,KAAK,CAAC,OAAO,CAAC,WAAW,IAAI,SAAS,CAAC,CAAC,CAAC;IAC/D,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC3E,IAAI,CAAC,kBAAkB,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;wBACE,OAAO,EAAE,IAAI;wBACb,IAAI,EAAE,IAAI;wBACV,OAAO,EACL,iFAAiF;wBACnF,IAAI,EAAE,OAAO,CAAC,IAAI;qBACnB,EACD,IAAI,EACJ,CAAC,CACF;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAA0B;QACpC,GAAG,OAAO;QACV,gBAAgB,EACd,MAAM,CAAC,gBAAgB,KAAK,SAAS;YACnC,CAAC,CAAC,MAAM,CAAC,gBAAgB;YACzB,CAAC,CAAC,OAAO,CAAC,gBAAgB;QAC9B,WAAW,EACT,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW;QAC7E,YAAY,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAC3B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,KAAK,GAAG,CAAC,uBAAuB,CACzE,CAAC;YACF,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;QACpC,CAAC,CAAC;KACH,CAAC;IAEF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;QACrD,OAAO,EAAE,0BAA0B,OAAO,CAAC,IAAI,MAAM,OAAO,CAAC,IAAI,cAAc,SAAS,GAAG;QAC3F,eAAe,EAAE,OAAO;QACxB,MAAM,EAAE;YACN,MAAM,EAAE,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC;YACpD,MAAM,EAAE,eAAe,CAAC,MAAM,EAAE,UAAU,CAAC;SAC5C;KACF,CAAC,CAAC;IACH,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;QAC5B,OAAO,mBAAmB,CAAC,YAAY,EAAE;YACvC,MAAM,EAAE,uBAAuB;SAChC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,CAAC,QAAQ,CACnB,qDAAqD,EACrD,MAAM,EACN,EAAE,OAAO,EAAE,SAAS,EAAE,CACvB,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,qBAAqB,CAAC,KAAK,EAAE;YAC3B,UAAU,EAAE,gBAAgB;YAC5B,QAAQ,EAAE,OAAO,CAAC,EAAE;YACpB,SAAS;YACT,QAAQ,EACN,mOAAmO;SACtO,CAAC,CAAC;IACL,CAAC;IAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACnD,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACrD,MAAM,WAAW,GAAG,oBAAoB,YAAY,aAAa,gBAAgB,mBAAmB,WAAW,EAAE,CAAC;IAElH,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAe;gBACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;oBACE,OAAO,EAAE,IAAI;oBACb,EAAE,EAAE,OAAO,CAAC,EAAE;oBACd,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,WAAW;oBACX,OAAO,EAAE,mBAAmB,OAAO,CAAC,IAAI,yBAAyB;oBACjE,QAAQ,EACN,0DAA0D;iBAC7D,EACD,IAAI,EACJ,CAAC,CACF;aACF;SACF;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,+BAA+B,CAAC,MAAiB;IAC/D,MAAM,CAAC,YAAY,CACjB,uBAAuB,EACvB;QACE,KAAK,EAAE,yBAAyB;QAChC,WAAW,EAAE;;;;;;uLAMoK;QACjL,WAAW,EAAE,yBAAyB;QACtC,WAAW,EAAE,kCAAkC;KAChD,EACD,CAAC,IAAI,EAAE,EAAE,CAAC,0BAA0B,CAAC,MAAM,EAAE,IAAI,CAAC,CACnD,CAAC;AACJ,CAAC;AAED,sBAAsB,CAAC;IACrB,QAAQ,EAAE,uBAAuB;IACjC,MAAM,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,KAAK,EAAE;IACtD,UAAU,EAAE,+BAA+B;IAC3C,qBAAqB,EAAE,cAAc;CACtC,CAAC,CAAC"}
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Wire-format types for the customer-facing Feature Toggles API.
|
|
3
|
+
*
|
|
4
|
+
* Octopus's @octopusdeploy/api-client (3.8.0) does not expose typed Repository
|
|
5
|
+
* classes or Resource interfaces for feature toggles, so we declare the minimum
|
|
6
|
+
* surface we touch here. Field names and casing match the JSON response from
|
|
7
|
+
* /api/{spaceId}/projects/{projectId}/featuretoggles{,/{slug}}.
|
|
8
|
+
*/
|
|
9
|
+
export interface FeatureToggleEnvironmentResource {
|
|
10
|
+
FeatureToggleId?: string;
|
|
11
|
+
DeploymentEnvironmentId: string;
|
|
12
|
+
IsEnabled: boolean;
|
|
13
|
+
RolloutPercentage?: number;
|
|
14
|
+
ClientRolloutPercentage?: number;
|
|
15
|
+
TenantIds?: string[];
|
|
16
|
+
ExcludedTenantIds?: string[];
|
|
17
|
+
TenantTags?: string[];
|
|
18
|
+
ExcludedTenantTags?: string[];
|
|
19
|
+
Segments?: Array<{
|
|
20
|
+
Key: string;
|
|
21
|
+
Value: string;
|
|
22
|
+
}>;
|
|
23
|
+
MinimumVersion?: string | null;
|
|
24
|
+
}
|
|
25
|
+
export interface FeatureToggleResource {
|
|
26
|
+
Id: string;
|
|
27
|
+
SpaceId: string;
|
|
28
|
+
ProjectId: string;
|
|
29
|
+
Name: string;
|
|
30
|
+
Slug: string;
|
|
31
|
+
DefaultIsEnabled: boolean;
|
|
32
|
+
Description?: string | null;
|
|
33
|
+
Environments: FeatureToggleEnvironmentResource[];
|
|
34
|
+
Tags: string[];
|
|
35
|
+
RolloutGroupId?: string | null;
|
|
36
|
+
}
|
|
37
|
+
export interface RolloutGroupResource {
|
|
38
|
+
Id: string;
|
|
39
|
+
SpaceId: string;
|
|
40
|
+
ProjectId: string;
|
|
41
|
+
Name: string;
|
|
42
|
+
FeatureToggleUsages: Array<{
|
|
43
|
+
Id: string;
|
|
44
|
+
Name: string;
|
|
45
|
+
}>;
|
|
46
|
+
}
|
|
47
|
+
//# sourceMappingURL=featureToggleTypes.d.ts.map
|