domain_list
List all service and custom domains for a Railway service to view endpoints, manage configurations, and audit domain settings.
Instructions
[API] List all domains (both service and custom) for a service
⚡️ Best for: ✓ Viewing service endpoints ✓ Managing domain configurations ✓ Auditing domain settings
→ Prerequisites: service_list
→ Next steps: domain_create, domain_update
→ Related: service_info, tcp_proxy_list
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | ID of the project containing the service | |
| environmentId | Yes | ID of the environment that the service is in to list domains from (usually obtained from service_list) | |
| serviceId | Yes | ID of the service to list domains for |
Implementation Reference
- src/tools/domain.tool.ts:27-29 (handler)The handler function that executes the 'domain_list' tool logic by calling domainService.listDomains(projectId, environmentId, serviceId).async ({ projectId, environmentId, serviceId }) => { return domainService.listDomains(projectId, environmentId, serviceId); }
- src/tools/domain.tool.ts:22-26 (schema)Zod input schema defining parameters for the 'domain_list' tool: projectId, environmentId, serviceId.{ projectId: z.string().describe("ID of the project containing the service"), environmentId: z.string().describe("ID of the environment that the service is in to list domains from (usually obtained from service_list)"), serviceId: z.string().describe("ID of the service to list domains for") },
- src/tools/index.ts:16-37 (registration)The registerAllTools function collects tools from various modules, including domainTools (which contains 'domain_list'), and registers them 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 ); }); }
- src/tools/domain.tool.ts:5-30 (registration)Export of domainTools array where the 'domain_list' tool is created and defined using createTool, making it available for registration.export const domainTools = [ createTool( "domain_list", formatToolDescription({ type: 'API', description: "List all domains (both service and custom) for a service", bestFor: [ "Viewing service endpoints", "Managing domain configurations", "Auditing domain settings" ], relations: { prerequisites: ["service_list"], nextSteps: ["domain_create", "domain_update"], related: ["service_info", "tcp_proxy_list"] } }), { projectId: z.string().describe("ID of the project containing the service"), environmentId: z.string().describe("ID of the environment that the service is in to list domains from (usually obtained from service_list)"), serviceId: z.string().describe("ID of the service to list domains for") }, async ({ projectId, environmentId, serviceId }) => { return domainService.listDomains(projectId, environmentId, serviceId); } ),