service_update
Update a service's configuration to change settings, modify resource limits, or adjust deployment parameters in Railway.app infrastructure.
Instructions
[API] Update a service's configuration
⚡️ Best for: ✓ Changing service settings ✓ Updating resource limits ✓ Modifying deployment configuration
⚠️ Not for: × Updating environment variables (use variable_set) × Restarting services (use service_restart) × Triggering new deployments (use deployment_trigger)
→ Prerequisites: service_list, service_info
→ Next steps: deployment_trigger
→ Related: service_restart, variable_set
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | ID of the project containing the service | |
| serviceId | Yes | ID of the service to update | |
| environmentId | Yes | ID of the environment to update (usually obtained from service_info) | |
| region | No | Optional: Region to deploy the service in | |
| rootDirectory | No | Optional: Root directory containing the service code | |
| buildCommand | No | Optional: Command to build the service | |
| startCommand | No | Optional: Command to start the service | |
| numReplicas | No | Optional: Number of service replicas to run | |
| healthcheckPath | No | Optional: Path for health checks | |
| sleepApplication | No | Optional: Whether to enable sleep mode |
Implementation Reference
- src/tools/service.tool.ts:123-159 (registration)Registration of the 'service_update' tool using createTool, including formatted description, input schema with Zod validators, and the handler function.createTool( "service_update", formatToolDescription({ type: 'API', description: "Update a service's configuration", bestFor: [ "Changing service settings", "Updating resource limits", "Modifying deployment configuration" ], notFor: [ "Updating environment variables (use variable_set)", "Restarting services (use service_restart)", "Triggering new deployments (use deployment_trigger)" ], relations: { prerequisites: ["service_list", "service_info"], nextSteps: ["deployment_trigger"], related: ["service_restart", "variable_set"] } }), { projectId: z.string().describe("ID of the project containing the service"), serviceId: z.string().describe("ID of the service to update"), environmentId: z.string().describe("ID of the environment to update (usually obtained from service_info)"), region: RegionCodeSchema.optional().describe("Optional: Region to deploy the service in"), rootDirectory: z.string().optional().describe("Optional: Root directory containing the service code"), buildCommand: z.string().optional().describe("Optional: Command to build the service"), startCommand: z.string().optional().describe("Optional: Command to start the service"), numReplicas: z.number().optional().describe("Optional: Number of service replicas to run"), healthcheckPath: z.string().optional().describe("Optional: Path for health checks"), sleepApplication: z.boolean().optional().describe("Optional: Whether to enable sleep mode") }, async ({ projectId, serviceId, environmentId, ...config }) => { return serviceService.updateService(projectId, serviceId, environmentId, config); } ),
- src/tools/service.tool.ts:156-158 (handler)The MCP tool handler function for 'service_update', which spreads the config parameters and delegates to the serviceService.updateService method.async ({ projectId, serviceId, environmentId, ...config }) => { return serviceService.updateService(projectId, serviceId, environmentId, config); }
- src/tools/service.tool.ts:144-155 (schema)Input schema for the 'service_update' tool using Zod, defining required projectId, serviceId, environmentId and optional configuration fields.{ projectId: z.string().describe("ID of the project containing the service"), serviceId: z.string().describe("ID of the service to update"), environmentId: z.string().describe("ID of the environment to update (usually obtained from service_info)"), region: RegionCodeSchema.optional().describe("Optional: Region to deploy the service in"), rootDirectory: z.string().optional().describe("Optional: Root directory containing the service code"), buildCommand: z.string().optional().describe("Optional: Command to build the service"), startCommand: z.string().optional().describe("Optional: Command to start the service"), numReplicas: z.number().optional().describe("Optional: Number of service replicas to run"), healthcheckPath: z.string().optional().describe("Optional: Path for health checks"), sleepApplication: z.boolean().optional().describe("Optional: Whether to enable sleep mode") },
- Helper method in ServiceService class that performs the actual service update by calling the client API (this.client.services.updateServiceInstance) and handles success/error responses.async updateService(projectId: string, serviceId: string, environmentId: string, config: Partial<ServiceInstance>) { try { const updated = await this.client.services.updateServiceInstance(serviceId, environmentId, config); if (!updated) { return createErrorResponse(`Error updating service: Failed to update service instance of ${serviceId} in environment ${environmentId}`); } return createSuccessResponse({ text: `Service configuration updated successfully` }); } catch (error) { return createErrorResponse(`Error updating service: ${formatError(error)}`); } }
- src/tools/index.ts:16-37 (registration)Central MCP tool registration function that includes serviceTools (containing service_update) and registers all tools with the MCP server using 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 ); }); }