@octopusdeploy/mcp-server 1.0.1 → 2.1.0

package/dist/tools/deployRelease.js

@@ -0,0 +1,227 @@
+import { Client, DeploymentRepository } from "@octopusdeploy/api-client";
+import { z } from "zod";
+import {} from "@modelcontextprotocol/sdk/server/mcp.js";
+import { getClientConfigurationFromEnvironment } from "../helpers/getClientConfigurationFromEnvironment.js";
+import { registerToolDefinition } from "../types/toolConfig.js";
+import { DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS } from "../types/toolAnnotations.js";
+import { handleOctopusApiError } from "../helpers/errorHandling.js";
+import { requireConfirmation, unconfirmedResponse, } from "../helpers/requireConfirmation.js";
+export function registerDeployReleaseTool(server) {
+    server.registerTool("deploy_release", {
+        title: "Deploy a release to environments in Octopus Deploy",
+        description: `Deploy a release to one or more environments in Octopus Deploy
+
+This tool supports both tenanted and untenanted deployments:
+- **Untenanted**: Don't provide tenants or tenantTags. Can deploy to multiple environments at once.
+- **Tenanted**: Provide tenants or tenantTags. Can only deploy to ONE environment, but can target multiple tenants.
+
+The tool automatically determines which deployment type to use based on the parameters provided.`,
+        inputSchema: {
+            spaceName: z.string().describe("The space name"),
+            projectName: z.string().describe("The project name"),
+            releaseVersion: z
+                .string()
+                .describe("The release version to deploy (e.g., '1.0.0')"),
+            environmentNames: z
+                .array(z.string())
+                .describe("Array of environment names. For tenanted deployments, must contain exactly one environment."),
+            tenants: z
+                .array(z.string())
+                .optional()
+                .describe("Array of tenant names for tenanted deployment (optional)"),
+            tenantTags: z
+                .array(z.string())
+                .optional()
+                .describe("Array of tenant tags for tenanted deployment (e.g., ['Region/US-West', 'Tier/Production'])"),
+            forcePackageRedeployment: z
+                .boolean()
+                .optional()
+                .describe("Force redeployment of packages"),
+            updateVariableSnapshot: z
+                .boolean()
+                .optional()
+                .describe("Update the variable snapshot"),
+            forcePackageDownload: z
+                .boolean()
+                .optional()
+                .describe("Force package download"),
+            specificMachineNames: z
+                .array(z.string())
+                .optional()
+                .describe("Deploy to specific machines only"),
+            excludedMachineNames: z
+                .array(z.string())
+                .optional()
+                .describe("Exclude specific machines from deployment"),
+            skipStepNames: z
+                .array(z.string())
+                .optional()
+                .describe("Skip specific deployment steps"),
+            useGuidedFailure: z
+                .boolean()
+                .optional()
+                .describe("Use guided failure mode"),
+            runAt: z
+                .string()
+                .optional()
+                .describe("Schedule deployment for later (ISO 8601 date string)"),
+            noRunAfter: z
+                .string()
+                .optional()
+                .describe("Don't run deployment after this time (ISO 8601 date string)"),
+            variables: z
+                .record(z.string())
+                .optional()
+                .describe("Prompted variable values as key-value pairs"),
+            deploymentFreezeOverrideReason: z
+                .string()
+                .optional()
+                .describe("Reason for overriding deployment freeze"),
+            deploymentFreezeNames: z
+                .array(z.string())
+                .optional()
+                .describe("Names of deployment freezes to override"),
+            confirm: z
+                .boolean()
+                .optional()
+                .describe("Required only when the MCP client does not support elicitation. Set to true to confirm deployment; otherwise the tool aborts."),
+        },
+        annotations: DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS,
+    }, async ({ spaceName, projectName, releaseVersion, environmentNames, tenants, tenantTags, forcePackageRedeployment, updateVariableSnapshot, forcePackageDownload, specificMachineNames, excludedMachineNames, skipStepNames, useGuidedFailure, runAt, noRunAfter, variables, deploymentFreezeOverrideReason, deploymentFreezeNames, confirm, }) => {
+        try {
+            // Validate environment names
+            if (!environmentNames || environmentNames.length === 0) {
+                throw new Error("At least one environment name must be provided.");
+            }
+            // Determine if this is a tenanted deployment
+            const isTenanted = (tenants && tenants.length > 0) ||
+                (tenantTags && tenantTags.length > 0);
+            // Validate tenanted deployment constraints
+            if (isTenanted && environmentNames.length !== 1) {
+                throw new Error(`Tenanted deployments can only target one environment at a time. You provided ${environmentNames.length} environments. ` +
+                    `For tenanted deployments, specify exactly one environment in environmentNames, then use tenants or tenantTags to target specific tenants.`);
+            }
+            const tenantSummary = isTenanted
+                ? ` for tenants [${(tenants ?? []).join(", ")}${tenantTags?.length ? `; tags: ${tenantTags.join(", ")}` : ""}]`
+                : "";
+            const confirmMessage = `Deploy release ${releaseVersion} of ${projectName} to ` +
+                `[${environmentNames.join(", ")}]${tenantSummary} in space ${spaceName}?`;
+            // Build common parameters
+            const commonParams = {
+                spaceName: spaceName,
+                ProjectName: projectName,
+                ...(forcePackageRedeployment !== undefined && {
+                    ForcePackageRedeployment: forcePackageRedeployment,
+                }),
+                ...(updateVariableSnapshot !== undefined && {
+                    UpdateVariableSnapshot: updateVariableSnapshot,
+                }),
+                ...(forcePackageDownload !== undefined && {
+                    ForcePackageDownload: forcePackageDownload,
+                }),
+                ...(specificMachineNames && {
+                    SpecificMachineNames: specificMachineNames,
+                }),
+                ...(excludedMachineNames && {
+                    ExcludedMachineNames: excludedMachineNames,
+                }),
+                ...(skipStepNames && { SkipStepNames: skipStepNames }),
+                ...(useGuidedFailure !== undefined && {
+                    UseGuidedFailure: useGuidedFailure,
+                }),
+                ...(runAt && { RunAt: new Date(runAt) }),
+                ...(noRunAfter && { NoRunAfter: new Date(noRunAfter) }),
+                ...(variables && { Variables: variables }),
+                ...(deploymentFreezeOverrideReason && {
+                    DeploymentFreezeOverrideReason: deploymentFreezeOverrideReason,
+                }),
+                ...(deploymentFreezeNames && {
+                    DeploymentFreezeNames: deploymentFreezeNames,
+                }),
+            };
+            const tenantedCommand = {
+                ...commonParams,
+                ReleaseVersion: releaseVersion,
+                EnvironmentName: environmentNames[0],
+                Tenants: tenants || [],
+                TenantTags: tenantTags || [],
+            };
+            const untenantedCommand = {
+                ...commonParams,
+                ReleaseVersion: releaseVersion,
+                EnvironmentNames: environmentNames,
+            };
+            const confirmation = await requireConfirmation(server, {
+                message: confirmMessage,
+                fallbackConfirm: confirm,
+                change: {
+                    source: {},
+                    target: isTenanted ? tenantedCommand : untenantedCommand,
+                },
+            });
+            if (!confirmation.confirmed) {
+                return unconfirmedResponse(confirmation, { action: "deployment" });
+            }
+            const configuration = getClientConfigurationFromEnvironment();
+            const client = await Client.create(configuration);
+            const deploymentRepository = new DeploymentRepository(client, spaceName);
+            const deploymentType = isTenanted ? "tenanted" : "untenanted";
+            const response = isTenanted
+                ? await deploymentRepository.createTenanted(tenantedCommand)
+                : await deploymentRepository.create(untenantedCommand);
+            // Format the response
+            const tasks = response.DeploymentServerTasks || [];
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: JSON.stringify({
+                            success: true,
+                            deploymentType,
+                            deploymentsCreated: tasks.length,
+                            deploymentTasks: tasks.map((task) => ({
+                                taskId: task.ServerTaskId,
+                                deploymentId: task.DeploymentId,
+                            })),
+                            message: `Successfully created ${tasks.length} deployment(s) for release ${releaseVersion}`,
+                            helpText: `Fetch octopus://spaces/{spaceName}/tasks/{taskId} (or /details for the structured activity tree) via resources/read or read_resource to monitor deployment progress. To search the raw log for a specific error or step, call grep_task_log with the taskId. Use list_deployments for high-level deployment listings.`,
+                        }, null, 2),
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            // Handle validation errors from our code
+            if (error instanceof Error && !error.message.includes("octopus")) {
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: JSON.stringify({
+                                success: false,
+                                error: error.message,
+                            }, null, 2),
+                        },
+                    ],
+                    isError: true,
+                };
+            }
+            // Handle Octopus API errors
+            handleOctopusApiError(error, {
+                entityType: "deployment",
+                spaceName,
+                helpText: "Use list_projects to find valid project names, list_environments for environment names, find_releases to verify the release exists, and find_tenants for tenant information. Ensure you have permissions to create deployments.",
+            });
+        }
+    });
+}
+registerToolDefinition({
+    toolName: "deploy_release",
+    config: { toolset: "deployments", readOnly: false },
+    registerFn: registerDeployReleaseTool,
+    // DeploymentRepository.create / .createTenanted use the Executions API
+    // (~/api/{space}/deployments/create/v1 and /create/tenanted/v1-alpha) which
+    // the api-client refuses to call against servers older than 2022.3.5512.
+    minimumOctopusVersion: "2022.3.5512",
+});
+//# sourceMappingURL=deployRelease.js.map

package/dist/tools/deployRelease.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deployRelease.js","sourceRoot":"","sources":["../../src/tools/deployRelease.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,yBAAyB,CAAC,MAAiB;IACzD,MAAM,CAAC,YAAY,CACjB,gBAAgB,EAChB;QACE,KAAK,EAAE,oDAAoD;QAC3D,WAAW,EAAE;;;;;;iGAM8E;QAC3F,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,cAAc,EAAE,CAAC;iBACd,MAAM,EAAE;iBACR,QAAQ,CAAC,+CAA+C,CAAC;YAC5D,gBAAgB,EAAE,CAAC;iBAChB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,CACP,6FAA6F,CAC9F;YACH,OAAO,EAAE,CAAC;iBACP,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,0DAA0D,CAAC;YACvE,UAAU,EAAE,CAAC;iBACV,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CACP,4FAA4F,CAC7F;YACH,wBAAwB,EAAE,CAAC;iBACxB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,gCAAgC,CAAC;YAC7C,sBAAsB,EAAE,CAAC;iBACtB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,8BAA8B,CAAC;YAC3C,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,kCAAkC,CAAC;YAC/C,oBAAoB,EAAE,CAAC;iBACpB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,2CAA2C,CAAC;YACxD,aAAa,EAAE,CAAC;iBACb,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,gCAAgC,CAAC;YAC7C,gBAAgB,EAAE,CAAC;iBAChB,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CAAC,yBAAyB,CAAC;YACtC,KAAK,EAAE,CAAC;iBACL,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,sDAAsD,CAAC;YACnE,UAAU,EAAE,CAAC;iBACV,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CACP,6DAA6D,CAC9D;YACH,SAAS,EAAE,CAAC;iBACT,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBAClB,QAAQ,EAAE;iBACV,QAAQ,CAAC,6CAA6C,CAAC;YAC1D,8BAA8B,EAAE,CAAC;iBAC9B,MAAM,EAAE;iBACR,QAAQ,EAAE;iBACV,QAAQ,CAAC,yCAAyC,CAAC;YACtD,qBAAqB,EAAE,CAAC;iBACrB,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;iBACjB,QAAQ,EAAE;iBACV,QAAQ,CAAC,yCAAyC,CAAC;YACtD,OAAO,EAAE,CAAC;iBACP,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,QAAQ,CACP,+HAA+H,CAChI;SACJ;QACD,WAAW,EAAE,kCAAkC;KAChD,EACD,KAAK,EAAE,EACL,SAAS,EACT,WAAW,EACX,cAAc,EACd,gBAAgB,EAChB,OAAO,EACP,UAAU,EACV,wBAAwB,EACxB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,oBAAoB,EACpB,aAAa,EACb,gBAAgB,EAChB,KAAK,EACL,UAAU,EACV,SAAS,EACT,8BAA8B,EAC9B,qBAAqB,EACrB,OAAO,GACR,EAAE,EAAE;QACH,IAAI,CAAC;YACH,6BAA6B;YAC7B,IAAI,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,CAAC;YAED,6CAA6C;YAC7C,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,2CAA2C;YAC3C,IAAI,UAAU,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChD,MAAM,IAAI,KAAK,CACb,gFAAgF,gBAAgB,CAAC,MAAM,iBAAiB;oBACtH,2IAA2I,CAC9I,CAAC;YACJ,CAAC;YAED,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,kBAAkB,cAAc,OAAO,WAAW,MAAM;gBACxD,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,aAAa,aAAa,SAAS,GAAG,CAAC;YAE5E,0BAA0B;YAC1B,MAAM,YAAY,GAAG;gBACnB,SAAS,EAAE,SAAS;gBACpB,WAAW,EAAE,WAAW;gBACxB,GAAG,CAAC,wBAAwB,KAAK,SAAS,IAAI;oBAC5C,wBAAwB,EAAE,wBAAwB;iBACnD,CAAC;gBACF,GAAG,CAAC,sBAAsB,KAAK,SAAS,IAAI;oBAC1C,sBAAsB,EAAE,sBAAsB;iBAC/C,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,gBAAgB,KAAK,SAAS,IAAI;oBACpC,gBAAgB,EAAE,gBAAgB;iBACnC,CAAC;gBACF,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;gBACvD,GAAG,CAAC,SAAS,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;gBAC1C,GAAG,CAAC,8BAA8B,IAAI;oBACpC,8BAA8B,EAAE,8BAA8B;iBAC/D,CAAC;gBACF,GAAG,CAAC,qBAAqB,IAAI;oBAC3B,qBAAqB,EAAE,qBAAqB;iBAC7C,CAAC;aACH,CAAC;YAEF,MAAM,eAAe,GAAG;gBACtB,GAAG,YAAY;gBACf,cAAc,EAAE,cAAc;gBAC9B,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC;gBACpC,OAAO,EAAE,OAAO,IAAI,EAAE;gBACtB,UAAU,EAAE,UAAU,IAAI,EAAE;aAC7B,CAAC;YACF,MAAM,iBAAiB,GAAG;gBACxB,GAAG,YAAY;gBACf,cAAc,EAAE,cAAc;gBAC9B,gBAAgB,EAAE,gBAAgB;aACnC,CAAC;YAEF,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;gBACrD,OAAO,EAAE,cAAc;gBACvB,eAAe,EAAE,OAAO;gBACxB,MAAM,EAAE;oBACN,MAAM,EAAE,EAAE;oBACV,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,iBAAiB;iBACzD;aACF,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;gBAC5B,OAAO,mBAAmB,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC;YACrE,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,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC;YAC9D,MAAM,QAAQ,GAAG,UAAU;gBACzB,CAAC,CAAC,MAAM,oBAAoB,CAAC,cAAc,CAAC,eAAe,CAAC;gBAC5D,CAAC,CAAC,MAAM,oBAAoB,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;YAEzD,sBAAsB;YACtB,MAAM,KAAK,GAAG,QAAQ,CAAC,qBAAqB,IAAI,EAAE,CAAC;YAEnD,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAM;wBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;4BACE,OAAO,EAAE,IAAI;4BACb,cAAc;4BACd,kBAAkB,EAAE,KAAK,CAAC,MAAM;4BAChC,eAAe,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gCACpC,MAAM,EAAE,IAAI,CAAC,YAAY;gCACzB,YAAY,EAAE,IAAI,CAAC,YAAY;6BAChC,CAAC,CAAC;4BACH,OAAO,EAAE,wBAAwB,KAAK,CAAC,MAAM,8BAA8B,cAAc,EAAE;4BAC3F,QAAQ,EAAE,uTAAuT;yBAClU,EACD,IAAI,EACJ,CAAC,CACF;qBACF;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,yCAAyC;YACzC,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,4BAA4B;YAC5B,qBAAqB,CAAC,KAAK,EAAE;gBAC3B,UAAU,EAAE,YAAY;gBACxB,SAAS;gBACT,QAAQ,EACN,iOAAiO;aACpO,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED,sBAAsB,CAAC;IACrB,QAAQ,EAAE,gBAAgB;IAC1B,MAAM,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE;IACnD,UAAU,EAAE,yBAAyB;IACrC,uEAAuE;IACvE,4EAA4E;IAC5E,yEAAyE;IACzE,qBAAqB,EAAE,aAAa;CACrC,CAAC,CAAC"}

package/dist/tools/execute.d.ts

@@ -0,0 +1,3 @@
+import { type McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+export declare function registerExecuteTool(server: McpServer): void;
+//# sourceMappingURL=execute.d.ts.map

package/dist/tools/execute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute.d.ts","sourceRoot":"","sources":["../../src/tools/execute.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAsKzE,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,QAmLpD"}

package/dist/tools/execute.js

@@ -0,0 +1,261 @@
+import { Client } from "@octopusdeploy/api-client";
+import { z } from "zod";
+import {} from "@modelcontextprotocol/sdk/server/mcp.js";
+import { registerToolDefinition } from "../types/toolConfig.js";
+import { DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS } from "../types/toolAnnotations.js";
+import { getClientConfigurationFromEnvironment } from "../helpers/getClientConfigurationFromEnvironment.js";
+import { HTTP_METHODS, classifyMethod, } from "../helpers/methodTier.js";
+import { isSensitive } from "../helpers/sensitivePathDenylist.js";
+import { matchPath, findOwningToolset } from "../helpers/pathAllowlist.js";
+import { validateExecutePath } from "../helpers/validateExecutePath.js";
+import { requireConfirmation, unconfirmedResponse, } from "../helpers/requireConfirmation.js";
+import { getActiveToolsetConfig } from "../helpers/activeToolsetConfig.js";
+import { DEFAULT_TOOLSETS, } from "../types/toolConfig.js";
+function errorResponse(payload) {
+    return {
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(payload, null, 2),
+            },
+        ],
+        isError: true,
+    };
+}
+function summariseBody(body) {
+    if (body == null)
+        return "(no body)";
+    if (typeof body === "string") {
+        return body.length > 200 ? `${body.slice(0, 200)}…` : body;
+    }
+    try {
+        const json = JSON.stringify(body);
+        if (json.length <= 400)
+            return json;
+        return `${json.slice(0, 400)}… (${json.length} bytes total)`;
+    }
+    catch {
+        return "(unserialisable body)";
+    }
+}
+/**
+ * Build a one-shot audit emitter scoped to a single execute call. Captures
+ * the start time so callers only state outcome + reason — no need to repeat
+ * method/tier/path/durationMs at every gate. Stub on stderr; replace with the
+ * structured emitter from AIF-357 once it lands.
+ */
+function startAudit(call) {
+    const startedAt = Date.now();
+    return (outcome, reason) => {
+        process.stderr.write(JSON.stringify({
+            ts: new Date().toISOString(),
+            tool: "execute",
+            ...call,
+            outcome,
+            ...(reason !== undefined ? { reason } : {}),
+            durationMs: Date.now() - startedAt,
+        }) + "\n");
+    };
+}
+function resolveEnabledToolsets() {
+    const config = getActiveToolsetConfig();
+    if (config.enabledToolsets === "all" || config.enabledToolsets == null) {
+        return DEFAULT_TOOLSETS;
+    }
+    return config.enabledToolsets;
+}
+async function dispatchExecute(client, method, path, query, body) {
+    const dispatchable = client;
+    const url = dispatchable.resolveUrl(path, query);
+    return dispatchable.dispatchRequest(method, url, body ?? null);
+}
+const inputSchema = {
+    method: z
+        .enum(HTTP_METHODS)
+        .describe("HTTP method. The method itself is the read/write/delete classifier — GET is read-only, POST/PUT/PATCH are blocked when --read-only is set, DELETE additionally requires --allow-deletes. The agent cannot bypass this by lying about intent."),
+    path: z
+        .string()
+        .min(1)
+        .describe("Path under the configured Octopus server, e.g. '/api/spaces/Spaces-1/feeds' or '/api/Spaces-1/projects'. Discover paths via grep_llms_txt."),
+    query: z
+        .record(z.string())
+        .optional()
+        .describe("Optional query-string parameters as a flat object."),
+    body: z
+        .unknown()
+        .optional()
+        .describe("Optional request body for POST/PUT/PATCH calls."),
+    asCsv: z
+        .boolean()
+        .optional()
+        .describe("If true, request 'text/csv' for tabular GET responses. The Octopus API honours this for endpoints that support CSV output."),
+    confirm: z
+        .boolean()
+        .optional()
+        .describe("Required only when the MCP client does not support elicitation. Set to true to confirm a non-GET call; otherwise the tool aborts."),
+};
+export function registerExecuteTool(server) {
+    server.registerTool("execute", {
+        title: "Execute an Octopus REST request (backstop)",
+        description: `Reach Octopus REST endpoints not covered by the curated tools. Use this only after grep_llms_txt has shown you the right method and path.
+
+**Method gating is hard-coded server-side, three tiers:**
+
+  - GET    → read tier: always allowed (subject to toolset allowlist + sensitive denylist).
+  - POST/PUT/PATCH → write tier: blocked when --read-only is set; requires user confirmation via elicitation otherwise.
+  - DELETE → delete tier: requires --allow-deletes (and is blocked when --read-only is set) AND a stronger user confirmation.
+
+The HTTP method enum is the gate. The tool will not honour any 'isRead' flag the agent invents — the runtime classifies based on the actual method.
+
+**Other gates** (in order):
+  1. Sensitive denylist: API key endpoints and catastrophic deletes (DELETE /api/users/{id}, DELETE /api/spaces/{id}) are always blocked.
+  2. Path allowlist by enabled toolset: paths only resolve if their owning toolset is enabled. Disabling a toolset (e.g. 'certificates') makes its endpoints unreachable even on GET.
+  3. Elicitation on every non-GET, with a stronger message for DELETE.
+
+Discover endpoints with grep_llms_txt. Use octopus://api/capabilities to see which toolsets are enabled and whether write/delete modes are on.`,
+        inputSchema,
+        annotations: DESTRUCTIVE_WRITE_TOOL_ANNOTATIONS,
+    }, async (args) => {
+        const params = args;
+        const { method, path: rawPath, query, body, asCsv } = params;
+        const tier = classifyMethod(method);
+        const audit = startAudit({ method, tier, path: rawPath });
+        const config = getActiveToolsetConfig();
+        const readOnlyMode = config.readOnlyMode ?? false;
+        const allowDeletes = config.allowDeletes ?? false;
+        // Gate 0: path canonicalization. Reject paths that can mean different
+        // things to the allowlist matcher and the HTTP client (`..` traversal,
+        // encoded slashes, query strings, fragments, backslashes). Runs FIRST
+        // so a traversal attempt cannot pass any later gate.
+        const validation = validateExecutePath(rawPath);
+        if (!validation.ok) {
+            audit("blocked", "invalidPath");
+            return errorResponse({
+                success: false,
+                reason: "invalidPath",
+                message: `Invalid path: ${validation.reason}`,
+            });
+        }
+        const path = validation.path;
+        // Gate 1: sensitive denylist (always-on, applies regardless of mode).
+        const sensitive = isSensitive(method, path);
+        if (sensitive.blocked) {
+            audit("blocked", "sensitivePath");
+            return errorResponse({
+                success: false,
+                reason: "sensitivePath",
+                message: `Path '${path}' is on the sensitive denylist and cannot be reached via execute. ${sensitive.reason ?? ""}`.trim(),
+            });
+        }
+        // Gate 2: tier-based mode gate.
+        if (tier === "write" && readOnlyMode) {
+            audit("blocked", "readOnlyMode");
+            return errorResponse({
+                success: false,
+                reason: "readOnlyMode",
+                message: "This server is in read-only mode. Restart without --read-only to enable write requests through the execute tool.",
+            });
+        }
+        if (tier === "delete") {
+            if (readOnlyMode) {
+                audit("blocked", "readOnlyMode");
+                return errorResponse({
+                    success: false,
+                    reason: "readOnlyMode",
+                    message: "This server is in read-only mode. Restart without --read-only AND with --allow-deletes to permit DELETE requests through the execute tool.",
+                });
+            }
+            if (!allowDeletes) {
+                audit("blocked", "deletesNotAllowed");
+                return errorResponse({
+                    success: false,
+                    reason: "deletesNotAllowed",
+                    message: "DELETE requests are not permitted. Restart with --allow-deletes to enable them. This is a deliberate opt-in for irreversible operations.",
+                });
+            }
+        }
+        // Gate 3: path allowlist by enabled toolset.
+        const enabledToolsets = resolveEnabledToolsets();
+        const allowed = matchPath(path, enabledToolsets);
+        if (!allowed.matched) {
+            const owner = findOwningToolset(path);
+            audit("blocked", "pathNotAllowed");
+            return errorResponse({
+                success: false,
+                reason: "pathNotAllowed",
+                message: owner
+                    ? `Path '${path}' belongs to the '${owner}' toolset which is not enabled in this session. Enable it via --toolsets to reach this endpoint.`
+                    : `Path '${path}' is not on the execute allowlist for any toolset. If this is a legitimate Octopus endpoint not yet covered, file an issue against the MCP server.`,
+            });
+        }
+        // Gate 4: elicitation on every non-GET.
+        if (tier !== "read") {
+            const isDelete = tier === "delete";
+            const message = isDelete
+                ? `IRREVERSIBLE delete operation. Confirm carefully.\n\n${method} ${path}\nQuery: ${JSON.stringify(query ?? {})}\nBody: ${summariseBody(body)}`
+                : `${method} ${path}\nQuery: ${JSON.stringify(query ?? {})}\nBody: ${summariseBody(body)}`;
+            const confirmation = await requireConfirmation(server, {
+                message,
+                fallbackConfirm: params.confirm,
+            });
+            if (!confirmation.confirmed) {
+                audit("cancelled", confirmation.reason);
+                return unconfirmedResponse(confirmation, {
+                    action: isDelete ? "deletion" : "API call",
+                });
+            }
+        }
+        // All gates passed. Dispatch.
+        try {
+            const client = await Client.create(getClientConfigurationFromEnvironment());
+            const requestQuery = asCsv
+                ? { ...(query ?? {}), format: "csv" }
+                : query;
+            const result = await dispatchExecute(client, method, path, requestQuery, body);
+            audit("ok");
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: JSON.stringify({
+                            success: true,
+                            method,
+                            path,
+                            tier,
+                            response: result,
+                        }),
+                    },
+                ],
+            };
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            audit("error", message);
+            return {
+                content: [
+                    {
+                        type: "text",
+                        text: JSON.stringify({
+                            success: false,
+                            reason: "octopusError",
+                            method,
+                            path,
+                            tier,
+                            message,
+                        }, null, 2),
+                    },
+                ],
+                isError: true,
+            };
+        }
+    });
+}
+registerToolDefinition({
+    toolName: "execute",
+    // readOnly: true so the tool is registered even in --read-only mode (where
+    // only its GET branch is reachable). Method-tier gating inside the handler
+    // enforces the actual write/delete policy at runtime.
+    config: { toolset: "core", readOnly: true },
+    registerFn: registerExecuteTool,
+});
+//# sourceMappingURL=execute.js.map

package/dist/tools/execute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute.js","sourceRoot":"","sources":["../../src/tools/execute.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAC;AACnD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAkB,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,kCAAkC,EAAE,MAAM,6BAA6B,CAAC;AACjF,OAAO,EAAE,qCAAqC,EAAE,MAAM,qDAAqD,CAAC;AAC5G,OAAO,EACL,YAAY,EACZ,cAAc,GAGf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EACL,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EACL,gBAAgB,GAEjB,MAAM,wBAAwB,CAAC;AAuBhC,SAAS,aAAa,CAAC,OAA6B;IAClD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAe;gBACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;aACvC;SACF;QACD,OAAO,EAAE,IAAI;KACd,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,IAAa;IAClC,IAAI,IAAI,IAAI,IAAI;QAAE,OAAO,WAAW,CAAC;IACrC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7D,CAAC;IACD,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG;YAAE,OAAO,IAAI,CAAC;QACpC,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,eAAe,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,uBAAuB,CAAC;IACjC,CAAC;AACH,CAAC;AAUD;;;;;GAKG;AACH,SAAS,UAAU,CAAC,IAAe;IAIjC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC7B,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACzB,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,IAAI,CAAC,SAAS,CAAC;YACb,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YAC5B,IAAI,EAAE,SAAS;YACf,GAAG,IAAI;YACP,OAAO;YACP,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3C,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS;SACnC,CAAC,GAAG,IAAI,CACV,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB;IAC7B,MAAM,MAAM,GAAG,sBAAsB,EAAE,CAAC;IACxC,IAAI,MAAM,CAAC,eAAe,KAAK,KAAK,IAAI,MAAM,CAAC,eAAe,IAAI,IAAI,EAAE,CAAC;QACvE,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IACD,OAAO,MAAM,CAAC,eAAe,CAAC;AAChC,CAAC;AAWD,KAAK,UAAU,eAAe,CAC5B,MAAc,EACd,MAAkB,EAClB,IAAY,EACZ,KAAyC,EACzC,IAAa;IAEb,MAAM,YAAY,GAAG,MAAuC,CAAC;IAC7D,MAAM,GAAG,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACjD,OAAO,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,IAAI,IAAI,CAAC,CAAC;AACjE,CAAC;AAED,MAAM,WAAW,GAAG;IAClB,MAAM,EAAE,CAAC;SACN,IAAI,CAAC,YAAwD,CAAC;SAC9D,QAAQ,CACP,8OAA8O,CAC/O;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CACP,4IAA4I,CAC7I;IACH,KAAK,EAAE,CAAC;SACL,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;SAClB,QAAQ,EAAE;SACV,QAAQ,CAAC,oDAAoD,CAAC;IACjE,IAAI,EAAE,CAAC;SACJ,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,KAAK,EAAE,CAAC;SACL,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,4HAA4H,CAC7H;IACH,OAAO,EAAE,CAAC;SACP,OAAO,EAAE;SACT,QAAQ,EAAE;SACV,QAAQ,CACP,mIAAmI,CACpI;CACJ,CAAC;AAEF,MAAM,UAAU,mBAAmB,CAAC,MAAiB;IACnD,MAAM,CAAC,YAAY,CACjB,SAAS,EACT;QACE,KAAK,EAAE,4CAA4C;QACnD,WAAW,EAAE;;;;;;;;;;;;;;;+IAe4H;QACzI,WAAW;QACX,WAAW,EAAE,kCAAkC;KAChD,EACD,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,MAAM,GAAG,IAAqB,CAAC;QACrC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAC7D,MAAM,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,KAAK,GAAG,UAAU,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,sBAAsB,EAAE,CAAC;QACxC,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC;QAClD,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC;QAElD,sEAAsE;QACtE,uEAAuE;QACvE,sEAAsE;QACtE,qDAAqD;QACrD,MAAM,UAAU,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAChD,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;YACnB,KAAK,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YAChC,OAAO,aAAa,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,aAAa;gBACrB,OAAO,EAAE,iBAAiB,UAAU,CAAC,MAAM,EAAE;aAC9C,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QAE7B,sEAAsE;QACtE,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC5C,IAAI,SAAS,CAAC,OAAO,EAAE,CAAC;YACtB,KAAK,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YAClC,OAAO,aAAa,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,eAAe;gBACvB,OAAO,EAAE,SAAS,IAAI,qEAAqE,SAAS,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE;aAC3H,CAAC,CAAC;QACL,CAAC;QAED,gCAAgC;QAChC,IAAI,IAAI,KAAK,OAAO,IAAI,YAAY,EAAE,CAAC;YACrC,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;YACjC,OAAO,aAAa,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,cAAc;gBACtB,OAAO,EACL,kHAAkH;aACrH,CAAC,CAAC;QACL,CAAC;QACD,IAAI,IAAI,KAAK,QAAQ,EAAE,CAAC;YACtB,IAAI,YAAY,EAAE,CAAC;gBACjB,KAAK,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC;gBACjC,OAAO,aAAa,CAAC;oBACnB,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,cAAc;oBACtB,OAAO,EACL,4IAA4I;iBAC/I,CAAC,CAAC;YACL,CAAC;YACD,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,KAAK,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;gBACtC,OAAO,aAAa,CAAC;oBACnB,OAAO,EAAE,KAAK;oBACd,MAAM,EAAE,mBAAmB;oBAC3B,OAAO,EACL,0IAA0I;iBAC7I,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,6CAA6C;QAC7C,MAAM,eAAe,GAAG,sBAAsB,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QACjD,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACtC,KAAK,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YACnC,OAAO,aAAa,CAAC;gBACnB,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,gBAAgB;gBACxB,OAAO,EAAE,KAAK;oBACZ,CAAC,CAAC,SAAS,IAAI,qBAAqB,KAAK,kGAAkG;oBAC3I,CAAC,CAAC,SAAS,IAAI,oJAAoJ;aACtK,CAAC,CAAC;QACL,CAAC;QAED,wCAAwC;QACxC,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,CAAC;YACnC,MAAM,OAAO,GAAG,QAAQ;gBACtB,CAAC,CAAC,wDAAwD,MAAM,IAAI,IAAI,YAAY,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,WAAW,aAAa,CAAC,IAAI,CAAC,EAAE;gBAC/I,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,YAAY,IAAI,CAAC,SAAS,CAAC,KAAK,IAAI,EAAE,CAAC,WAAW,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7F,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;gBACrD,OAAO;gBACP,eAAe,EAAE,MAAM,CAAC,OAAO;aAChC,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;gBAC5B,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;gBACxC,OAAO,mBAAmB,CAAC,YAAY,EAAE;oBACvC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU;iBAC3C,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,8BAA8B;QAC9B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAChC,qCAAqC,EAAE,CACxC,CAAC;YACF,MAAM,YAAY,GAAG,KAAK;gBACxB,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE;gBACrC,CAAC,CAAC,KAAK,CAAC;YACV,MAAM,MAAM,GAAG,MAAM,eAAe,CAClC,MAAM,EACN,MAAM,EACN,IAAI,EACJ,YAAY,EACZ,IAAI,CACL,CAAC;YACF,KAAK,CAAC,IAAI,CAAC,CAAC;YACZ,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;4BACnB,OAAO,EAAE,IAAI;4BACb,MAAM;4BACN,IAAI;4BACJ,IAAI;4BACJ,QAAQ,EAAE,MAAM;yBACjB,CAAC;qBACH;iBACF;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACvE,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACxB,OAAO;gBACL,OAAO,EAAE;oBACP;wBACE,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;4BACE,OAAO,EAAE,KAAK;4BACd,MAAM,EAAE,cAAc;4BACtB,MAAM;4BACN,IAAI;4BACJ,IAAI;4BACJ,OAAO;yBACR,EACD,IAAI,EACJ,CAAC,CACF;qBACF;iBACF;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC;AAED,sBAAsB,CAAC;IACrB,QAAQ,EAAE,SAAS;IACnB,2EAA2E;IAC3E,2EAA2E;IAC3E,sDAAsD;IACtD,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC3C,UAAU,EAAE,mBAAmB;CAChC,CAAC,CAAC"}

package/dist/tools/findAccounts.d.ts

@@ -0,0 +1,3 @@
+import { type McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+export declare function registerFindAccountsTool(server: McpServer): void;
+//# sourceMappingURL=findAccounts.d.ts.map

package/dist/tools/findAccounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findAccounts.d.ts","sourceRoot":"","sources":["../../src/tools/findAccounts.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAWzE,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,QAmGzD"}

package/dist/tools/findAccounts.js

@@ -0,0 +1,90 @@
+import { Client, resolveSpaceId } from "@octopusdeploy/api-client";
+import { z } from "zod";
+import {} from "@modelcontextprotocol/sdk/server/mcp.js";
+import { registerToolDefinition } from "../types/toolConfig.js";
+import { READ_ONLY_TOOL_ANNOTATIONS } from "../types/toolAnnotations.js";
+import { getClientConfigurationFromEnvironment } from "../helpers/getClientConfigurationFromEnvironment.js";
+import { mapAccountResource, AccountType } from "../types/accountTypes.js";
+import { validateEntityId, handleOctopusApiError, ENTITY_PREFIXES } from "../helpers/errorHandling.js";
+export function registerFindAccountsTool(server) {
+    server.registerTool("find_accounts", {
+        title: "Find accounts in an Octopus Deploy space",
+        description: `Find accounts in a space - can retrieve a single account by ID or list all accounts
+
+This unified tool can either:
+- Get detailed information about a specific account when accountId is provided
+- List all accounts in a space when accountId is omitted
+
+You can optionally filter by various parameters like name, account type, etc. when listing.`,
+        inputSchema: {
+            spaceName: z.string(),
+            accountId: z.string().optional().describe("The ID of a specific account to retrieve. If omitted, lists all accounts."),
+            skip: z.number().optional().describe("Number of accounts to skip for pagination (only used when listing)"),
+            take: z.number().optional().describe("Number of accounts to take for pagination (only used when listing)"),
+            ids: z.array(z.string()).optional().describe("Filter by specific account IDs (only used when listing)"),
+            partialName: z.string().optional().describe("Filter by partial name match (only used when listing)"),
+            accountType: z.nativeEnum(AccountType).optional().describe("Filter by account type (only used when listing)"),
+        },
+        annotations: READ_ONLY_TOOL_ANNOTATIONS,
+    }, async ({ spaceName, accountId, skip, take, ids, partialName, accountType, }) => {
+        const configuration = getClientConfigurationFromEnvironment();
+        const client = await Client.create(configuration);
+        const spaceId = await resolveSpaceId(client, spaceName);
+        // If accountId is provided, get a single account
+        if (accountId) {
+            validateEntityId(accountId, 'account', ENTITY_PREFIXES.account);
+            try {
+                const response = await client.get("~/api/{spaceId}/accounts/{id}", {
+                    spaceId,
+                    id: accountId,
+                });
+                const account = mapAccountResource(response);
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: JSON.stringify(account),
+                        },
+                    ],
+                };
+            }
+            catch (error) {
+                handleOctopusApiError(error, {
+                    entityType: 'account',
+                    entityId: accountId,
+                    spaceName
+                });
+            }
+        }
+        // Otherwise, list all accounts
+        const response = await client.get("~/api/{spaceId}/accounts{?skip,take,ids,partialName,accountType}", {
+            spaceId,
+            skip,
+            take,
+            ids,
+            partialName,
+            accountType,
+        });
+        const accounts = response.Items.map((account) => mapAccountResource(account));
+        return {
+            content: [
+                {
+                    type: "text",
+                    text: JSON.stringify({
+                        totalResults: response.TotalResults,
+                        itemsPerPage: response.ItemsPerPage,
+                        numberOfPages: response.NumberOfPages,
+                        lastPageNumber: response.LastPageNumber,
+                        items: accounts,
+                    }),
+                },
+            ],
+        };
+    });
+}
+registerToolDefinition({
+    toolName: "find_accounts",
+    config: { toolset: "accounts", readOnly: true },
+    registerFn: registerFindAccountsTool,
+});
+//# sourceMappingURL=findAccounts.js.map

package/dist/tools/findAccounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findAccounts.js","sourceRoot":"","sources":["../../src/tools/findAccounts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,cAAc,EAA2B,MAAM,2BAA2B,CAAC;AAC5F,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAkB,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AAChE,OAAO,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AACzE,OAAO,EAAE,qCAAqC,EAAE,MAAM,qDAAqD,CAAC;AAC5G,OAAO,EAEL,kBAAkB,EAClB,WAAW,EACZ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEvG,MAAM,UAAU,wBAAwB,CAAC,MAAiB;IACxD,MAAM,CAAC,YAAY,CACjB,eAAe,EACf;QACE,KAAK,EAAE,0CAA0C;QACjD,WAAW,EAAE;;;;;;4FAMyE;QACtF,WAAW,EAAE;YACX,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;YACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2EAA2E,CAAC;YACtH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oEAAoE,CAAC;YAC1G,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,oEAAoE,CAAC;YAC1G,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yDAAyD,CAAC;YACvG,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uDAAuD,CAAC;YACpG,WAAW,EAAE,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iDAAiD,CAAC;SAC9G;QACD,WAAW,EAAE,0BAA0B;KACxC,EACD,KAAK,EAAE,EACL,SAAS,EACT,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,GAAG,EACH,WAAW,EACX,WAAW,GACZ,EAAE,EAAE;QACH,MAAM,aAAa,GAAG,qCAAqC,EAAE,CAAC;QAC9D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAClD,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAExD,iDAAiD;QACjD,IAAI,SAAS,EAAE,CAAC;YACd,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,OAAO,CAAC,CAAC;YAEhE,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAC/B,+BAA+B,EAC/B;oBACE,OAAO;oBACP,EAAE,EAAE,SAAS;iBACd,CACF,CAAC;gBAEF,MAAM,OAAO,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBAE7C,OAAO;oBACL,OAAO,EAAE;wBACP;4BACE,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;yBAC9B;qBACF;iBACF,CAAC;YACJ,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,qBAAqB,CAAC,KAAK,EAAE;oBAC3B,UAAU,EAAE,SAAS;oBACrB,QAAQ,EAAE,SAAS;oBACnB,SAAS;iBACV,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAC/B,kEAAkE,EAClE;YACE,OAAO;YACP,IAAI;YACJ,IAAI;YACJ,GAAG;YACH,WAAW;YACX,WAAW;SACZ,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAwB,EAAE,EAAE,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;QAE/F,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACnB,YAAY,EAAE,QAAQ,CAAC,YAAY;wBACnC,YAAY,EAAE,QAAQ,CAAC,YAAY;wBACnC,aAAa,EAAE,QAAQ,CAAC,aAAa;wBACrC,cAAc,EAAE,QAAQ,CAAC,cAAc;wBACvC,KAAK,EAAE,QAAQ;qBAChB,CAAC;iBACH;aACF;SACF,CAAC;IACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED,sBAAsB,CAAC;IACrB,QAAQ,EAAE,eAAe;IACzB,MAAM,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE;IAC/C,UAAU,EAAE,wBAAwB;CACrC,CAAC,CAAC"}

package/dist/tools/findCertificates.d.ts

@@ -0,0 +1,3 @@
+import { type McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+export declare function registerFindCertificatesTool(server: McpServer): void;
+//# sourceMappingURL=findCertificates.d.ts.map

package/dist/tools/findCertificates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findCertificates.d.ts","sourceRoot":"","sources":["../../src/tools/findCertificates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAOzE,wBAAgB,4BAA4B,CAAC,MAAM,EAAE,SAAS,QA+G7D"}