Railway MCP Server

Instructions

Implementation Reference

• src/tools/service.tool.ts:84-86 (handler)

  The MCP tool handler function that executes the tool logic by calling serviceService.createServiceFromRepo.

  async ({ projectId, repo, name }) => {
    return serviceService.createServiceFromRepo(projectId, repo, name);
  }

• src/tools/service.tool.ts:79-83 (schema)

  Input schema using Zod defining the required parameters for the tool.

  {
    projectId: z.string().describe("ID of the project to create the service in"),
    repo: z.string().describe("GitHub repository URL or name (e.g., 'owner/repo')"),
    name: z.string().optional().describe("Optional custom name for the service")
  },

• src/tools/service.tool.ts:57-87 (registration)

  Tool definition and local registration using createTool function, including name, description, schema, and handler.

  createTool(
    "service_create_from_repo",
    formatToolDescription({
      type: 'API',
      description: "Create a new service from a GitHub repository",
      bestFor: [
        "Deploying applications from source code",
        "Services that need build processes",
        "GitHub-hosted projects"
      ],
      notFor: [
        "Pre-built Docker images (use service_create_from_image)",
        "Database deployments (use database_deploy)",
        "Static file hosting"
      ],
      relations: {
        prerequisites: ["project_list"],
        nextSteps: ["variable_set", "service_update"],
        alternatives: ["service_create_from_image", "database_deploy"],
        related: ["deployment_trigger", "service_info"]
      }
    }),
    {
      projectId: z.string().describe("ID of the project to create the service in"),
      repo: z.string().describe("GitHub repository URL or name (e.g., 'owner/repo')"),
      name: z.string().optional().describe("Optional custom name for the service")
    },
    async ({ projectId, repo, name }) => {
      return serviceService.createServiceFromRepo(projectId, repo, name);
    }
  ),

• src/services/service.service.ts:88-105 (helper)

  Supporting method in serviceService that performs the actual API call to create service from repo using the client.

  async createServiceFromRepo(projectId: string, repo: string, name?: string) {
    try {
      const service = await this.client.services.createService({
        projectId,
        name,
        source: {
          repo,
        }
      });
  
      return createSuccessResponse({
        text: `Created new service "${service.name}" (ID: ${service.id}) from GitHub repo "${repo}"`,
        data: service
      });
    } catch (error) {
      return createErrorResponse(`Error creating service: ${formatError(error)}`);
    }
  }

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

  Global registration where serviceTools (including service_create_from_repo) is spread into allTools and each tool registered with the MCP server via 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
      );
    });