service_update
Modify and update service configurations on Railway-MCP, including settings, resource limits, and deployment options. Use to adjust parameters like replicas, build commands, and health checks for optimized performance.
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
| Name | Required | Description | Default |
|---|---|---|---|
| buildCommand | No | Optional: Command to build the service | |
| environmentId | Yes | ID of the environment to update (usually obtained from service_info) | |
| healthcheckPath | No | Optional: Path for health checks | |
| numReplicas | No | Optional: Number of service replicas to run | |
| projectId | Yes | ID of the project containing the service | |
| region | No | Optional: Region to deploy the service in | |
| rootDirectory | No | Optional: Root directory containing the service code | |
| serviceId | Yes | ID of the service to update | |
| sleepApplication | No | Optional: Whether to enable sleep mode | |
| startCommand | No | Optional: Command to start the service |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"buildCommand": {
"description": "Optional: Command to build the service",
"type": "string"
},
"environmentId": {
"description": "ID of the environment to update (usually obtained from service_info)",
"type": "string"
},
"healthcheckPath": {
"description": "Optional: Path for health checks",
"type": "string"
},
"numReplicas": {
"description": "Optional: Number of service replicas to run",
"type": "number"
},
"projectId": {
"description": "ID of the project containing the service",
"type": "string"
},
"region": {
"description": "Optional: Region to deploy the service in",
"enum": [
"asia-southeast1",
"asia-southeast1-eqsg3a",
"europe-west4",
"europe-west4-drams3a",
"us-east4",
"us-east4-eqdc4a",
"us-west1",
"us-west2"
],
"type": "string"
},
"rootDirectory": {
"description": "Optional: Root directory containing the service code",
"type": "string"
},
"serviceId": {
"description": "ID of the service to update",
"type": "string"
},
"sleepApplication": {
"description": "Optional: Whether to enable sleep mode",
"type": "boolean"
},
"startCommand": {
"description": "Optional: Command to start the service",
"type": "string"
}
},
"required": [
"projectId",
"serviceId",
"environmentId"
],
"type": "object"
}
Implementation Reference
- src/tools/service.tool.ts:124-159 (registration)Defines and exports the service_update tool within serviceTools array using createTool, including formatted description, Zod input schema, and handler function"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); } ),
- ServiceService.updateService method: the core logic for updating service configuration via the API client, called by the tool's handlerasync 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-36 (registration)Registers all tools, including serviceTools containing service_update, to the MCP serverexport 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/tools/service.tool.ts:144-155 (schema)Zod schema defining input parameters for the service_update tool{ 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") },