deployment_trigger
Initiate new deployments for Railway services to apply code changes, configuration updates, or roll back to previous states using specific commit SHAs.
Instructions
[API] Trigger a new deployment for a service
⚡️ Best for: ✓ Deploying code changes ✓ Applying configuration updates ✓ Rolling back to previous states
⚠️ Not for: × Restarting services (use service_restart) × Updating service config (use service_update) × Database changes
→ Prerequisites: service_list
→ Alternatives: service_restart
→ Next steps: deployment_logs, deployment_status
→ Related: variable_set, service_update
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | ID of the project | |
| serviceId | Yes | ID of the service | |
| environmentId | Yes | ID of the environment | |
| commitSha | Yes | Specific commit SHA from the Git repository |
Implementation Reference
- src/tools/deployment.tool.ts:60-62 (handler)Handler function for the deployment_trigger tool, which delegates to deploymentService.triggerDeploymentasync ({ projectId, serviceId, environmentId, commitSha }) => { return deploymentService.triggerDeployment(projectId, serviceId, environmentId, commitSha); }
- src/tools/deployment.tool.ts:54-59 (schema)Zod schema defining input parameters for the deployment_trigger tool{ projectId: z.string().describe("ID of the project"), serviceId: z.string().describe("ID of the service"), environmentId: z.string().describe("ID of the environment"), commitSha: z.string().describe("Specific commit SHA from the Git repository") },
- src/tools/deployment.tool.ts:32-63 (registration)createTool call that registers the deployment_trigger tool, including description, schema, and handlercreateTool( "deployment_trigger", formatToolDescription({ type: 'API', description: "Trigger a new deployment for a service", bestFor: [ "Deploying code changes", "Applying configuration updates", "Rolling back to previous states" ], notFor: [ "Restarting services (use service_restart)", "Updating service config (use service_update)", "Database changes" ], relations: { prerequisites: ["service_list"], nextSteps: ["deployment_logs", "deployment_status"], alternatives: ["service_restart"], related: ["variable_set", "service_update"] } }), { projectId: z.string().describe("ID of the project"), serviceId: z.string().describe("ID of the service"), environmentId: z.string().describe("ID of the environment"), commitSha: z.string().describe("Specific commit SHA from the Git repository") }, async ({ projectId, serviceId, environmentId, commitSha }) => { return deploymentService.triggerDeployment(projectId, serviceId, environmentId, commitSha); } ),
- src/tools/index.ts:16-37 (registration)Registers all tools with the MCP server, including the deploymentTools array which contains deployment_triggerexport 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 ); }); }
- DeploymentService.triggerDeployment method called by the tool handler, wraps the repo call and formats responseasync triggerDeployment(projectId: string, serviceId: string, environmentId: string, commitSha?: string) { try { // Wait for 5 seconds before triggering deployment // Seems like the LLMs like to call this function multiple times in combination // with the health check function and the list deployments function // so we need to wait a bit to avoid rate limiting await new Promise(resolve => setTimeout(resolve, 5000)); const deploymentId = await this.client.deployments.triggerDeployment({ serviceId, environmentId, commitSha }); return createSuccessResponse({ text: `Triggered new deployment (ID: ${deploymentId})`, data: { deploymentId } }); } catch (error) { return createErrorResponse(`Error triggering deployment: ${formatError(error)}`); } }
- src/types.ts:209-213 (schema)TypeScript interface used in repo for DeploymentTriggerInputexport interface DeploymentTriggerInput { commitSha?: string; environmentId: string; serviceId: string; }