deployment_list

Instructions

Implementation Reference

• src/tools/deployment.tool.ts:27-29 (handler)

  The handler function for the 'deployment_list' tool, which invokes deploymentService.listDeployments with the provided parameters.

  async ({ projectId, serviceId, environmentId, limit = 10 }) => {
    return deploymentService.listDeployments(projectId, serviceId, environmentId, limit);
  }

• src/tools/deployment.tool.ts:22-26 (schema)

  Zod input schema defining parameters for the 'deployment_list' tool: projectId, serviceId, environmentId, and optional limit.

    projectId: z.string().describe("ID of the project containing the service"),
    serviceId: z.string().describe("ID of the service to list deployments for"),
    environmentId: z.string().describe("ID of the environment to list deployments from (usually obtained from service_list)"),
    limit: z.number().optional().describe("Optional: Maximum number of deployments to return (default: 10)")
  },

• src/tools/deployment.tool.ts:6-30 (registration)

  Tool registration using createTool, including name 'deployment_list', formatted description, schema, and handler. Part of the exported deploymentTools array.

  createTool(
    "deployment_list",
    formatToolDescription({
      type: 'API',
      description: "List recent deployments for a service in a specific environment",
      bestFor: [
        "Viewing deployment history",
        "Monitoring service updates"
      ],
      relations: {
        prerequisites: ["service_list"],
        nextSteps: ["deployment_logs", "deployment_trigger"],
        related: ["service_info", "service_restart"]
      }
    }),
    {
      projectId: z.string().describe("ID of the project containing the service"),
      serviceId: z.string().describe("ID of the service to list deployments for"),
      environmentId: z.string().describe("ID of the environment to list deployments from (usually obtained from service_list)"),
      limit: z.number().optional().describe("Optional: Maximum number of deployments to return (default: 10)")
    },
    async ({ projectId, serviceId, environmentId, limit = 10 }) => {
      return deploymentService.listDeployments(projectId, serviceId, environmentId, limit);
    }
  ),

• src/services/deployment.service.ts:11-45 (helper)

  DeploymentService.listDeployments method: Fetches deployments via API client, formats with emojis and details, handles empty results and errors.

    async listDeployments(projectId: string, serviceId: string, environmentId: string, limit: number = 5) {
      try {
        const deployments = await this.client.deployments.listDeployments({
          projectId,
          serviceId,
          environmentId,
          limit
        });
  
        if (deployments.length === 0) {
          return createSuccessResponse({
            text: "No deployments found for this service.",
            data: []
          });
        }
  
        const deploymentDetails = deployments.map(deployment => {
          const status = deployment.status.toLowerCase();
          const emoji = status === 'success' ? '✅' : status === 'failed' ? '❌' : '🔄';
          
          return `${emoji} Deployment ${deployment.id}
  Status: ${deployment.status}
  Created: ${new Date(deployment.createdAt).toLocaleString()}
  Service: ${deployment.serviceId}
  ${deployment.url ? `URL: ${deployment.url}` : ''}`;
        });
  
        return createSuccessResponse({
          text: `Recent deployments:\n\n${deploymentDetails.join('\n\n')}`,
          data: deployments
        });
      } catch (error) {
        return createErrorResponse(`Error listing deployments: ${formatError(error)}`);
      }
    }

• src/tools/index.ts:16-37 (registration)

  Final registration of all tools, including those from deploymentTools (containing deployment_list), to the MCP server via server.tool.

  export function registerAllTools(server: McpServer) {
    // Collect all tools
    const allTools = [
      ...databaseTools,
      ...deploymentTools,
      ...domainTools,
      ...projectTools,
      ...serviceTools,
      ...tcpProxyTools,
      ...variableTools,
      ...configTools,
      ...volumeTools,
      ...templateTools,
    ] as Tool[];
  
    // Register each tool with the server
    allTools.forEach((tool) => {
      server.tool(
        ...tool
      );
    });
  }