Railway MCP

🚀 鐵路 MCP 協議服務器文檔

鐵路 MCP 協議服務器可助力用戶高效管理和配置服務環境，通過一系列實用工具和命令，能輕鬆實現項目的自動化管理。

🚀 快速開始

要使用鐵路 MCP 協議服務器，需先完成安裝和配置，具體步驟如下：

📦 安裝指南

1. 安裝依賴

• 確保安裝 Node.js 版本 18 或更高。
• 使用 npm 安裝所有依賴：

npm install

2. 啟動服務

在項目根目錄下運行啟動腳本：

npm start

📚 詳細文檔

配置指南

設置 API 令牌

1. 將 Railway API 令牌添加到環境變量中：

export RAILWAY_TOKEN=your_token_here

2. 或者在 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 瞭解如何開始、開發規範及調試信息。

可用工具

env-set --key KEY_NAME --value VALUE

env-unset --key KEY_NAME

bulk-get --serviceIDs service1,service2

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 協議服務器提供強大的功能來管理和配置您的服務環境。通過合理使用提供的工具和命令，您可以輕鬆實現項目的自動化管理。