Skip to content

add MCP server badge #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add MCP server badge #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

A Model Context Protocol (MCP) server for interacting with your Railway account. This is a local MCP server provides a set of opinionated workflows and tools for managing Railway resources.

<a href="https://glama.ai/mcp/servers/@railwayapp/railway-mcp-server">
<img width="380" height="200" src="https://glama.ai/mcp/servers/@railwayapp/railway-mcp-server/badge" alt="Railway Server MCP server" />
</a>

> [!IMPORTANT]
> This is an experimental project (like really experimental). You should expect bugs and missing features. The MCP server doesn't include destructive actions by design, that said, you should still keep an eye on which tools and commands are being executed.

Expand Down Expand Up @@ -42,8 +46,6 @@ Add the following configuration to `.vscode/mcp.json`
}
```



## Example Usage

Creating a new project, deploying it, and generating a domain
Expand All @@ -52,7 +54,6 @@ Creating a new project, deploying it, and generating a domain
Create 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
```


Deploy a from a template (database, queue, etc.). Based on your prompt, the appropriate template will be selected and deployed. In case of multiple templates, the agent will pick the most appropriate one. Writing a detailed prompt will lead to a better selection. [Check out all of the available templates](https://railway.com/deploy).

```text
Expand All @@ -63,7 +64,6 @@ Deploy a Postgres database
Deploy a single node Clickhouse database
```


Pulling environment variables

```text
Expand Down Expand Up @@ -98,14 +98,12 @@ The Railway MCP Server provides the following tools for managing your Railway in
- Monitoring & Logs
- `get-logs` - Retrieve build or deployment logs for a service


## Development

### Prerequisites
- Node.js >= 20.0.0
- pnpm >= 10.14.0


1. **Clone the repository**
```bash
git clone https://github.com/railwayapp/railway-mcp-server.git
Expand Down Expand Up @@ -154,4 +152,4 @@ The Railway MCP Server provides the following tools for managing your Railway in
}
}
}
```
```