🚀 铁路 MCP 协议服务器文档
铁路 MCP 协议服务器可助力用户高效管理和配置服务环境，通过一系列实用工具和命令，能轻松实现项目的自动化管理。
🚀 快速开始
要使用铁路 MCP 协议服务器，需先完成安装和配置，具体步骤如下：
📦 安装指南
1. 安装依赖
- 确保安装 Node.js 版本 18 或更高。
- 使用 npm 安装所有依赖：
npm install
2. 启动服务
在项目根目录下运行启动脚本：
npm start
📚 详细文档
配置指南
设置 API 令牌
- 将 Railway API 令牌添加到环境变量中：
export RAILWAY_TOKEN=your_token_here
- 或者在
config.json文件中配置：
{
"token": "your_token_here"
}
安全注意事项
- 令牌安全：Railway API 令牌提供对您账户的完全访问权限。请确保令牌的安全性。
- 环境变量存储：当使用环境变量方法时，令牌会存储在 Claude Desktop 配置文件中。
- 敏感值屏蔽：所有敏感变量值在显示时都会自动屏蔽。
- HTTPS 使用：所有 API 请求均通过 HTTPS 进行加密通信。
- 内存存储：服务器仅使用内存来存储令牌，不会将其写入磁盘。
故障排除
1. 认证问题
- 确保令牌有效且具有必要的权限。
- 检查环境变量是否正确配置。
- 尝试在 Claude 中直接使用
configure工具。
2. 连接问题
- 确认安装了最新版本的服务器。
- 验证 Node.js 版本为 18 或更高。
- 在配置更改后重启 Claude。
3. API 错误
- 检查项目、环境和服务 ID 是否正确。
- 查看 Railway 的状态页面，确认是否有服务中断。
- 注意 Railway 的速率限制，避免短时间内频繁请求。
贡献指南
我们欢迎社区贡献！请查阅 CONTRIBUTING.md 了解如何开始、开发规范及调试信息。
可用工具
查看所有工具
认证
configure- 设置 Railway API 令牌（仅在环境变量未提供时使用）
项目管理
project-list- 列出您账户下的所有项目project-info- 获取特定项目的详细信息project-create- 创建新项目，可指定团队 IDproject-delete- 删除项目project-environments- 列出项目中的所有环境
服务管理
service-list- 在特定项目中列出所有服务service-info- 获取特定服务的详细信息service-create-from-repo- 从 GitHub 仓库创建新服务service-create-from-scratch- 从头开始创建新服务service-delete- 删除服务
环境变量管理
env-list- 列出服务的所有环境变量env-set- 设置或更新环境变量：
env-set --key KEY_NAME --value VALUE
env-unset- 删除特定环境变量：
env-unset --key KEY_NAME
批量操作
bulk-get- 获取多个服务的环境变量：
bulk-get --serviceIDs service1,service2
bulk-set- 批量设置环境变量：
bulk-set --serviceIDs service1,service2 --envs key=value,key2=value2
示例工作流
创建新项目并添加服务
project-create --name MyProject
service-create-from-repo --projectID my-project-id --repoURL https://github.com/username/repo.git
配置环境变量
env-set --serviceID my-service-id --key NODE_ENV --value production
bulk-set --serviceIDs service1,service2 --envs DB_URL=mysql://localhost:3306/dbname
总结
Railway MCP 协议服务器提供强大的功能来管理和配置您的服务环境。通过合理使用提供的工具和命令，您可以轻松实现项目的自动化管理。