Railway MCP Server 使用说明

项目简介

Railway MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在使大型语言模型 (LLM) 客户端能够通过自然语言指令便捷地管理 Railway.app 云平台上的基础设施。它提供了一系列工具，允许用户通过 LLM 客户端轻松管理 Railway 项目、服务、部署、环境变量等。

主要功能点

Railway 资源管理: 支持管理 Railway.app 的项目、环境、服务、部署、域名、TCP 代理、环境变量和存储卷等核心资源。
全面的工具集: 提供了丰富的工具，涵盖了 Railway.app 平台的大部分操作，例如：
- 项目管理：列出、查看信息、创建、删除项目和环境。
- 服务管理：列出、查看信息、从代码仓库或 Docker 镜像创建服务、更新服务配置、重启和删除服务。
- 部署管理：列出部署历史、触发新的部署、查看部署日志和状态。
- 变量管理：列出、设置、删除和批量管理环境变量。
- 数据库部署：支持使用 Railway 官方模板快速部署多种数据库服务。
- 域名和 TCP 代理管理：管理服务的域名和 TCP 代理设置。
- 存储卷管理：创建、更新和删除存储卷。
易于集成: 设计为与 MCP 客户端（如 Claude、Cursor 等）无缝集成，通过标准的 MCP 协议进行通信。

安装步骤

环境准备:
- 确保已安装 Node.js 18 或更高版本。
- 拥有一个有效的 Railway.app 账户。
- 在 Railway.app 账户设置中创建一个 API Token。
安装方式 (推荐使用 Smithery 自动安装):
- Claude Desktop: 运行命令 'npx -y @smithery/cli install @jason-tan-swe/railway-mcp --client claude'
- Cursor: 运行命令 'npx -y @smithery/cli@latest run @jason-tan-swe/railway-mcp --config "{"railwayApiToken":"token"}"'
手动安装 (适用于 Cursor 或 Claude 等 MCP 客户端):
- 参考仓库 README.md 文档中 “Manual Installation For Cursor” 或 “Manual Installation For Claude” 部分的详细步骤，手动配置 MCP 客户端，将服务器启动命令添加到客户端设置中。

服务器配置

对于 MCP 客户端，您需要配置 Railway MCP Server 的启动命令和参数，以便客户端能够连接到服务器。以下是通用的 JSON 格式配置信息，您需要根据您的 MCP 客户端进行配置：

{
  "server name": "railway-mcp",  // 自定义服务器名称，例如 railway-mcp
  "command": "npx",              // 启动命令，通常为 npx
  "args": ["-y", "@jasontanswe/railway-mcp"], // 命令参数，指定要运行的 npm 包
  "env": {
    "RAILWAY_API_TOKEN": "YOUR_RAILWAY_API_TOKEN"  // 环境变量，请替换为您的 Railway API Token
  }
}

配置参数说明:

'server name': MCP 服务器的名称，您可以自定义，用于在客户端中标识该服务器。
'command': 执行的命令，通常使用 'npx' 来运行 npm 包。
'args': 传递给命令的参数，这里指定运行 '@jasontanswe/railway-mcp' npm 包。'-y' 参数用于跳过 npm 安装时的确认提示。
'env': 环境变量配置，'RAILWAY_API_TOKEN' 是用于 Railway API 鉴权的 Token，请务必替换为您的实际 API Token。

基本使用方法

完成安装和配置后，在您的 MCP 客户端（例如 Claude 或 Cursor）中，即可使用自然语言指令来管理您的 Railway.app 基础设施。

例如:

'列出我的 Railway 项目'
'创建一个新的 Railway 项目，名称为 my-test-project'
'在项目 [项目ID] 中创建一个新的服务，从 GitHub 仓库 [仓库地址]'
'重启服务 [服务ID]'
'查看服务 [服务ID] 的部署日志'

更多可用的工具和使用示例，请参考仓库的 README.md 文档中的 “Available Tools” 和 “Example Workflows” 部分。

关键词