Railway MCP Server

🚀 鐵路MCP服務器（實驗性）

這是一個用於與你的鐵路（Railway）賬戶進行交互的模型上下文協議（MCP）服務器。此本地MCP服務器提供了一套用於管理鐵路資源的實用工作流和工具。

⚠️ 重要提示

這是一個實驗性項目（真的非常具有實驗性）。你可能會遇到漏洞和功能缺失的情況。該MCP服務器在設計上不包含破壞性操作，但你仍需留意正在執行的工具和命令。

🚀 快速開始

前提條件

此服務器的運行需要安裝鐵路命令行界面（Railway CLI）。

📦 安裝指南

Cursor

將以下配置添加到 .cursor/mcp.json 文件中：

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

VS Code

將以下配置添加到 .vscode/mcp.json 文件中：

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

💻 使用示例

基礎用法

創建新項目、部署並生成域名

在當前目錄創建一個Next.js應用，並將其部署到鐵路平臺。確保為其分配一個域名。由於是從頭開始，目前無需拉取有關部署或構建的信息。

從模板部署（數據庫、隊列等）

根據你的提示，將選擇並部署合適的模板。如果有多個模板，系統將選擇最合適的一個。詳細的提示將有助於做出更好的選擇。查看所有可用模板。

部署一個Postgres數據庫

部署一個單節點ClickHouse數據庫

拉取環境變量

我想拉取我項目的環境變量，並將它們保存到一個.env文件中。

創建新環境並將其設置為當前關聯環境

我想創建一個名為 `development` 的新開發環境，用於測試我的更改。此環境應複製生產環境。環境創建完成後，我想將其設置為我當前關聯的環境。

🔧 技術細節

可用的MCP工具

鐵路MCP服務器提供以下工具來管理你的鐵路基礎設施：

• check-railway-status - 檢查鐵路命令行界面是否已安裝以及用戶是否已登錄。
• 項目管理
  • list-projects - 列出所有鐵路項目。
  • create-project-and-link - 創建一個新項目並將其關聯到當前目錄。
• 服務管理
  • list-services - 列出項目中的所有服務。
  • link-service - 將一個服務關聯到當前目錄。
  • deploy - 部署一個服務。
  • deploy-template - 從鐵路模板庫部署一個模板。
• 環境管理
  • create-environment - 創建一個新環境。
  • link-environment - 將一個環境關聯到當前目錄。
• 配置與變量
  • list-variables - 列出環境變量。
  • set-variables - 設置環境變量。
  • generate-domain - 為項目生成一個 railway.app 域名。
• 監控與日誌
  • get-logs - 檢索服務的構建或部署日誌。

🛠️ 開發指南

前提條件

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

步驟

1. 克隆倉庫

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

2. 安裝依賴

pnpm install

3. 啟動開發服務器

pnpm dev

此命令將在 dist/ 目錄下生成一個構建文件，並在你進行更改後自動重新構建。

4. 配置你的MCP客戶端 將以下配置添加到你的MCP客戶端（如Cursor、VSCode），並將 /path/to/railway-mcp-server/dist/index.js 替換為你實際構建的服務器路徑。

Cursor

.cursor/mcp.json

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

VSCode

.vscode/mcp.json

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