Railway MCP Server

🚀 Railway MCP Server (Experimental)

A Model Context Protocol (MCP) server for interacting with your Railway account. It offers a set of well - defined workflows and tools for managing Railway resources.

🚀 Quick Start

This is an MCP server that enables interaction with your Railway account. It provides a series of workflows and tools for managing Railway resources.

⚠️ Important Note

This is an experimental project (truly experimental). You should anticipate bugs and missing features. By design, the MCP server doesn't include destructive actions. However, you should still keep an eye on the tools and commands being executed.

✨ Features

• Interact with your Railway account through the MCP server.
• Provide a set of workflows and tools for managing Railway resources.
• Support multiple client configurations such as Cursor and VS Code.

📦 Installation

Prerequisites

The Railway CLI is required for this server to function.

Installation Steps

Cursor

Add the following configuration to .cursor/mcp.json:

{
  "mcpServers": {
    "railway-mcp-server": {
      "command": "npx",
      "args": ["-y", "@railway/mcp-server"]
    }
  }
}

VS Code

Add the following configuration to .vscode/mcp.json:

{
  "servers": {
    "railway-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@railway/mcp-server"]
    }
  }
}

💻 Usage Examples

Basic Usage

• Create a new project, deploy it, and generate a domain

Create a Next.js app in this directory and deploy it to Railway. Make sure to also assign it a domain. Since we're starting from scratch, there is no need to pull information about the deployment or build for now

Advanced Usage

• Deploy from a template Deploy a from a template (database, queue, etc.). Based on your prompt, the appropriate template will be selected and deployed. In case of multiple templates, the agent will pick the most appropriate one. Writing a detailed prompt will lead to a better selection. Check out all of the available templates.

Deploy a Postgres database

Deploy a single node Clickhouse database

• Pull environment variables

I would like to pull environment variables for my project and save them in a .env file

• Create a new environment and set it as the current linked environment

I would like to create a new development environment called `development` where I can test my changes. This environment should duplicate production. Once the environment is created, I want to set it as my current linked environment

🔧 Technical Details

The Railway MCP Server provides the following tools for managing your Railway infrastructure:

📚 Documentation

Development

Prerequisites

• Node.js >= 20.0.0
• pnpm >= 10.14.0

Steps

1. Clone the repository

git clone https://github.com/railwayapp/railway-mcp-server.git
cd railway-mcp-server

2. Install dependencies

pnpm install

3. Start the development server

pnpm dev

This command will generate a build under dist/ and automatically rebuild after making changes.

4. Configure your MCP client Add the following configuration to your MCP client (e.g., Cursor, VSCode) and replace /path/to/railway-mcp-server/dist/index.js with the actual path to your built server.

Cursor

{
  "mcpServers": {
    "railway-mcp-server": {
      "command": "node",
      "args": ["/path/to/railway-mcp-server/dist/index.js"]
    }
  }
}

VSCode

{
  "servers": {
    "railway-mcp-server": {
      "type": "stdio",
      "command": "node",
      "args": ["/path/to/railway-mcp-server/dist/index.js"]
    }
  }
}