maquina-app/rails-mcp-server

A Ruby implementation of a Model Context Protocol (MCP) server for Rails projects. This server allows LLMs (Large Language Models) to interact with Rails projects through the Model Context Protocol, providing capabilities for code analysis, exploration, and development assistance.
## What is MCP?
The Model Context Protocol (MCP) is a standardized way for AI models to interact with their environment. It defines a structured method for models to request and use tools, access resources, and maintain context during interactions.
This Rails MCP Server implements the MCP specification to give AI models access to Rails projects for code analysis, exploration, and assistance.
## Features
Manage multiple Rails projects
Browse project files and structures
View Rails routes with filtering options
Inspect model information and relationships (with Prism static analysis)
Get database schema information
Analyze controller-view relationships
Analyze environment configurations
Access comprehensive Rails, Turbo, Stimulus, and Kamal documentation
Context-efficient architecture with progressive tool discovery
Seamless integration with LLM clients
## Installation
Install the gem:
bash
gem install rails-mcp-server
After installation, the following executables will be available in your PATH:
rails-mcp-server - The MCP server itself
rails-mcp-config - Interactive configuration tool (recommended)
rails-mcp-setup-claude - Legacy Claude Desktop setup script
rails-mcp-server-download-resources - Legacy resource download script
## Configuration
### Using the Configuration Tool (Recommended)
The easiest way to configure the Rails MCP Server is using the interactive configuration tool:
bash
rails-mcp-config
This provides a user-friendly TUI (Terminal User Interface) for:
Managing Projects: Add, edit, remove, and validate Rails projects
Downloading Guides: Download Rails, Turbo, Stimulus, and Kamal documentation
Importing Custom Guides: Add your own markdown documentation
Claude Desktop Integration: Automatically configure Claude Desktop
The tool uses Gum for an enhanced experience if installed, but works with a basic terminal fallback.
bash
# Install Gum for best experience (optional)
brew install gum # macOS
sudo apt install gum # Debian/Ubuntu
yay -S gum # Arch Linux
### Manual Configuration
The Rails MCP Server follows the XDG Base Directory Specification for configuration files:
On macOS: $XDGCONFIGHOME/rails-mcp or ~/.config/rails-mcp if XDGCONFIGHOME is not set
On Windows: %APPDATA%\rails-mcp
The server will automatically create these directories and an empty projects.yml file the first time it runs.
To configure your projects manually:
1. Edit the projects.yml file in your config directory to include your Rails projects:
yaml
store: "~/projects/store"
blog: "~/projects/rails-blog"
ecommerce: "/full/path/to/ecommerce-app"
Each key in the YAML file is a project name (which will be used with the switchproject tool), and each value is the path to the project directory.
## Usage
### Starting the server
The Rails MCP Server can run in two modes:
1. STDIO mode (default): Communicates over standard input/output for direct integration with clients like Claude Desktop.