railway-mcp

Instructions

Implementation Reference

• src/tools/domain.tool.ts:71-92 (registration)

  Full tool definition using createTool, including name, formatted description, input schema, and handler function for the 'domain_check' tool.

  createTool(
    "domain_check",
    formatToolDescription({
      type: 'API',
      description: "Check if a domain is available for use",
      bestFor: [
        "Validating domain availability",
        "Pre-deployment checks",
        "Domain planning"
      ],
      relations: {
        nextSteps: ["domain_create"],
        related: ["domain_list"]
      }
    }),
    {
      domain: z.string().describe("Domain name to check availability for")
    },
    async ({ domain }) => {
      return domainService.checkDomainAvailability(domain);
    }
  ),

• src/tools/domain.tool.ts:89-91 (handler)

  The executor/handler function provided to the MCP server for the domain_check tool.

  async ({ domain }) => {
    return domainService.checkDomainAvailability(domain);
  }

• src/tools/domain.tool.ts:86-88 (schema)

  Input schema validation using Zod for the domain_check tool.

  {
    domain: z.string().describe("Domain name to check availability for")
  },

• src/services/domain.service.ts:130-148 (helper)

  Supporting service method that performs the actual domain availability check via the Railway client API and handles response formatting.

  async checkDomainAvailability(domain: string): Promise<CallToolResult> {
    try {
      const result = await this.client.domains.serviceDomainAvailable(domain);
      
      if (result.available) {
        return createSuccessResponse({
          text: `Domain ${domain} is available`,
          data: result
        });
      } else {
        return createSuccessResponse({
          text: `Domain ${domain} is not available: ${result.message}`,
          data: result
        });
      }
    } catch (error) {
      return createErrorResponse(`Error checking domain availability: ${formatError(error)}`);
    }
  }

• src/tools/index.ts:32-36 (registration)

  Generic registration of all tools, including domain_check (imported via domainTools), to the MCP server.

  allTools.forEach((tool) => {
    server.tool(
      ...tool
    );
  });