deployment_logs

Instructions

Implementation Reference

• src/tools/deployment.tool.ts:89-91 (handler)

  Handler function that executes the deployment_logs tool logic by calling the deployment service.

  async ({ deploymentId, limit = 100 }) => {
    return deploymentService.getDeploymentLogs(deploymentId, limit);
  }

• src/tools/deployment.tool.ts:85-88 (schema)

  Input schema using Zod for validating parameters of the deployment_logs tool.

  {
    deploymentId: z.string().describe("ID of the deployment to get logs for"),
    limit: z.number().optional().describe("Maximum number of log entries to fetch")
  },

• src/tools/deployment.tool.ts:66-92 (registration)

  Creation of the deployment_logs tool object including name, description, schema, and handler using createTool.

    "deployment_logs",
    formatToolDescription({
      type: 'API',
      description: "Get logs for a specific deployment",
      bestFor: [
        "Debugging deployment issues",
        "Monitoring deployment progress",
        "Checking build output"
      ],
      notFor: [
        "Service runtime logs",
        "Database logs"
      ],
      relations: {
        prerequisites: ["deployment_list"],
        nextSteps: ["deployment_status"],
        related: ["service_info", "deployment_trigger"]
      }
    }),
    {
      deploymentId: z.string().describe("ID of the deployment to get logs for"),
      limit: z.number().optional().describe("Maximum number of log entries to fetch")
    },
    async ({ deploymentId, limit = 100 }) => {
      return deploymentService.getDeploymentLogs(deploymentId, limit);
    }
  ),

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

  Registration function that registers all tools, including deploymentTools containing deployment_logs, to the MCP server.

  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
      );
    });
  } 

• src/services/deployment.service.ts:69-101 (helper)

  Supporting service method that fetches build and deployment logs, formats them, and returns a response. Called by the tool handler.

  async getDeploymentLogs(deploymentId: string, limit: number = 100) {
    try {
      // Wait for 5 seconds before fetching logs
      // Seems like the LLMs like to call this function multiple times in combination
      // with the health check function, so we need to wait a bit to avoid rate limiting
      await new Promise(resolve => setTimeout(resolve, 5000));
      const buildLogs = await this.client.deployments.getBuildLogs(deploymentId, limit);
      const deploymentLogs = await this.client.deployments.getDeploymentLogs(deploymentId, limit);
  
      const logs: DeploymentLog[] = [...buildLogs.map(log => ({ ...log, type: 'build' as const })), ...deploymentLogs.map(log => ({ ...log, type: 'deployment' as const })) ];
  
      if (logs.length === 0) {
        return createSuccessResponse({
          text: `No logs found for deployment ${deploymentId}`,
          data: []
        });
      }
  
      const formattedLogs = logs.map(log => {
        const timestamp = new Date(log.timestamp).toLocaleString();
        const severity = log.severity.toLowerCase();
        const emoji = severity === 'error' ? '❌' : severity === 'warn' ? '⚠️' : '📝';
        return `[${log.type}] [${timestamp}] ${emoji} ${log.message}`;
      }).join('\n');
  
      return createSuccessResponse({
        text: formattedLogs,
        data: logs
      });
    } catch (error) {
      return createErrorResponse(`Error fetching logs: ${formatError(error)}`);
    }
  }