🚀 铁路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
步骤
- 克隆仓库
git clone https://github.com/railwayapp/railway-mcp-server.git
cd railway-mcp-server
- 安装依赖
pnpm install
- 启动开发服务器
pnpm dev
此命令将在 dist/ 目录下生成一个构建文件，并在你进行更改后自动重新构建。
- 配置你的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"]
}
}
}