volume_delete
Delete a volume from a service to remove unused storage and manage resources on Railway.app infrastructure. Use for storage cleanup after backing up data.
Instructions
[API] Delete a volume from a service
⚡️ Best for: ✓ Removing unused storage ✓ Storage cleanup ✓ Resource management
⚠️ Not for: × Temporary data removal × Data backup (use volume_backup first)
→ Prerequisites: volume_list
→ Related: service_update
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| volumeId | Yes | ID of the volume to delete |
Implementation Reference
- src/tools/volume.tool.ts:74-99 (registration)Registration of the 'volume_delete' MCP tool using createTool, including detailed description, input schema (volumeId: string), and handler function that calls volumeService.deleteVolume
createTool( "volume_delete", formatToolDescription({ type: 'API', description: "Delete a volume from a service", bestFor: [ "Removing unused storage", "Storage cleanup", "Resource management" ], notFor: [ "Temporary data removal", "Data backup (use volume_backup first)" ], relations: { prerequisites: ["volume_list"], related: ["service_update"] } }), { volumeId: z.string().describe("ID of the volume to delete") }, async ({ volumeId }) => { return volumeService.deleteVolume(volumeId); } ) - src/tools/volume.tool.ts:93-95 (schema)Input schema for volume_delete tool using Zod
{ volumeId: z.string().describe("ID of the volume to delete") }, - src/tools/volume.tool.ts:96-98 (handler)Handler function for volume_delete tool execution
async ({ volumeId }) => { return volumeService.deleteVolume(volumeId); } - volumeService.deleteVolume implementation, handles error/success responses and calls client.volumes.deleteVolume
async deleteVolume(volumeId: string): Promise<CallToolResult> { try { const success = await this.client.volumes.deleteVolume(volumeId); if (success) { return createSuccessResponse({ text: "✅ Volume deleted successfully", data: { success } }); } else { return createErrorResponse("Failed to delete volume"); } } catch (error) { return createErrorResponse(`Error deleting volume: ${formatError(error)}`); } } - VolumeRepository.deleteVolume executes the GraphQL mutation to delete the volume via Railway API client
async deleteVolume(volumeId: string): Promise<boolean> { const data = await this.client.request<{ volumeDelete: boolean }>(` mutation volumeDelete($volumeId: String!) { volumeDelete(volumeId: $volumeId) } `, { volumeId }); return data.volumeDelete; }