铁路MCP服务器
用于与您的Railway帐户交互的模型上下文协议(MCP)服务器。这是一个本地MCP服务器,为管理铁路资源提供了一套有主见的工作流程和工具。
[!重要] MCP服务器的设计不包括破坏性操作,也就是说,你仍然应该关注正在执行的工具和命令。
先决条件
这 铁路CLI 此服务器运行所必需的。
安装
您可以通过运行以下命令安装MCP服务器:
BASH``` 1npx add-mcp @railway/mcp-server —name railway
### 光标
您可以通过单击下面的按钮将铁路MCP服务器添加到光标。
[](https://cursor.com/en/install-mcp?name=railway-mcp-server&config=eyJjb21tYW5kIjoibnB4IC15IEByYWlsd2F5L21jcC1zZXJ2ZXIifQ%3D%3D)
或者,您可以将以下配置添加到 `.cursor/mcp.json`
JSON```
1
2
3
4
5
6
7
8{
"mcpServers": {
"railway-mcp-server": {
"command": "npx",
"args": ["-y", "@railway/mcp-server"]
}
}
}
VS代码:
将以下配置添加到 .vscode/mcp.json
JSON``` 1 2 3 4 5 6 7 8 9{ “servers”: { “railway-mcp-server”: { “type”: “stdio”, “command”: “npx”, “args”: [“-y”, “@railway/mcp-server”] } } }
### 克劳德代码:
SHELL```
1claude mcp add railway-mcp-server -- npx -y @railway/mcp-server
示例用法
创建一个新项目,部署它,并生成一个域
TEXT``` 1Create 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
从模板(数据库、队列等)部署。根据您的提示,将选择并部署适当的模板。如果有多个模板,代理将选择最合适的一个。写一个详细的提示会带来更好的选择。 [查看所有可用模板](https://railway.com/deploy).
TEXT```
1Deploy a Postgres database
TEXT``` 1Deploy a single node Clickhouse database
提取环境变量
TEXT```
1I would like to pull environment variables for my project and save them in a .env file
创建新环境并将其设置为当前链接环境
TEXT```
1I 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
## CLI版本检测
MCP服务器会自动检测您的Railway CLI版本以使用相应的功能。
## 可用的MCP工具
Railway MCP Server提供以下工具来管理您的铁路基础设施:
- `check-railway-status` -检查Railway CLI是否已安装以及用户是否已登录
- 项目管理
- `list-projects` -列出所有铁路项目
- `create-project-and-link` -创建一个新项目并将其链接到当前目录
- 服务管理
- `list-services` -列出项目中的所有服务
- `link-service` -将服务链接到当前目录
- `deploy` -部署服务
- `deploy-template` -从部署模板 [铁路模板库](https://railway.com/deploy)
- 环境管理
- `create-environment` -创建新环境
- `link-environment` -将环境链接到当前目录
- 配置和变量
- `list-variables` -列出环境变量
- `set-variables` -设置环境变量
- `generate-domain` -为项目生成railway.app域
- 监控和日志
- `get-logs` -检索服务的构建或部署日志
- **铁路CLI v4.9.0+**:支持 `lines` 限制输出的参数 `filter` 用于搜索日志的参数
- **较旧的CLI版本**:将流式传输没有过滤功能的日志
## 发展
### 先决条件
- Node.js>=20.0.0
- pnpm>=10.14.0
1. **克隆存储库**
BASH```
1
2git clone https://github.com/railwayapp/railway-mcp-server.git
cd railway-mcp-server
- 安装依赖项
BASH``` 1pnpm install
3. **启动开发服务器**
BASH```
1pnpm dev
此命令将在以下条件下生成构建 dist/ 并在做出更改后自动重建。
4. 配置您的MCP客户端
将以下配置添加到MCP客户端(例如Cursor、VSCode)并替换 /path/to/railway-mcp-server/dist/index.js 使用构建服务器的实际路径。
光标: .cursor/mcp.json
JSON``` 1 2 3 4 5 6 7 8{ “mcpServers”: { “railway-mcp-server”: { “command”: “node”, “args”: [“/path/to/railway-mcp-server/dist/index.js”] } } }
VSCode: `.vscode/mcp.json`
JSON```
1
2
3
4
5
6
7
8
9{
"servers": {
"railway-mcp-server": {
"type": "stdio",
"command": "node",
"args": ["/path/to/railway-mcp-server/dist/index.js"]
}
}
}
克劳德代码:
BASH``` 1claude mcp add railway-mcp-server node /path/to/railway-mcp-server/railway-mcp-server/dist/index.js