Railway MCP

🚀 Railway MCP Protocol Server Documentation

This documentation provides a comprehensive guide to the Railway MCP protocol server, including installation, configuration, security considerations, troubleshooting, and available tools.

🚀 Quick Start

📦 Installation

1. Install Dependencies:
   • Ensure Node.js version 18 or higher is installed.
   • Install all dependencies using npm:

   npm install
   

2. Start the Server:
   • Run the start script in the project root directory:

   npm start
   

⚙️ Configuration

Set API Token

1. Add the Railway API token to the environment variables:

   export RAILWAY_TOKEN=your_token_here
   

2. Or configure it in the config.json file:

   {
     "token": "your_token_here"
   }
   

🔒 Security Considerations

⚠️ Important Note

• Token Security: The Railway API token provides full access to your account. Ensure the security of your token.
• Environment Variable Storage: When using the environment variable method, the token is stored in the Claude Desktop configuration file.
• Sensitive Value Masking: All sensitive variable values are automatically masked when displayed.
• HTTPS Usage: All API requests are encrypted via HTTPS.
• Memory Storage: The server only uses memory to store tokens and does not write them to disk.

🛠️ Troubleshooting

1. Authentication Issues

• Ensure the token is valid and has the necessary permissions.
• Check if the environment variables are correctly configured.
• Try using the configure tool directly in Claude.

2. Connection Issues

• Confirm that the latest version of the server is installed.
• Verify that the Node.js version is 18 or higher.
• Restart Claude after configuration changes.

3. API Errors

• Check if the project, environment, and service IDs are correct.
• Check Railway's status page to confirm if there are any service outages.
• Be aware of Railway's rate limits to avoid frequent requests in a short period.

🤝 Contribution Guidelines

We welcome contributions from the community! Please refer to CONTRIBUTING.md for how to get started, development guidelines, and debugging information.

🛠️ Available Tools

💻 Usage Examples

Create a New Project and Add a Service

project-create --name MyProject
service-create-from-repo --projectID my-project-id --repoURL https://github.com/username/repo.git

Configure Environment Variables

env-set --serviceID my-service-id --key NODE_ENV --value production
bulk-set --serviceIDs service1,service2 --envs DB_URL=mysql://localhost:3306/dbname

📝 Summary

The Railway MCP protocol server provides powerful features to manage and configure your service environment. By using the provided tools and commands effectively, you can easily automate the management of your projects.