Rails MCP Server

by maquina-app

564 stars
403 downloads
Not rated
GitHub

About

A Ruby gem 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.

Details

Author
maquina-app
GitHub stars
564
Downloads
403
Categories
Developer Tools, Other

- Manage multiple Rails projects simultaneously
- Browse files, routes, models, schema, and controller–view relationships
- Execute sandboxed Ruby code for custom queries
- Access Rails, Turbo, Stimulus, and Kamal documentation
- Context-efficient progressive tool discovery (4 bootstrap tools)
- Run in STDIO or HTTP (JSON‑RPC + SSE) mode
- Automatic Claude Desktop and GitHub Copilot Agent integration

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Rails MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install the gem (gem install rails-mcp-server) and run the interactive configuration tool (rails-mcp-config) to manage projects and download documentation. Start the server in STDIO mode (default) or HTTP mode (rails-mcp-server --mode http). Integrate with Claude Desktop via the configuration tool or by editing claude_desktop_config.json. For GitHub Copilot, create a .github/copilot/mcp.json file pointing to the server.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "rails mcp server": {
            "rails-mcp-server": {
                "command": "npx",
                "args": [
                    "mcp-remote",
                    "http://localhost:6029/mcp/sse"
                ]
            }
        }
    }
}

McpServers

{
    "rails-mcp-server": {
        "command": "npx",
        "args": [
            "mcp-remote",
            "http://localhost:6029/mcp/sse"
        ]
    }
}

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
- Execute sandboxed Ruby code for custom queries
- Access comprehensive Rails, Turbo, Stimulus, and Kamal documentation
- Context-efficient architecture with progressive tool discovery
- Seamless integration with LLM clients

Installation

Install the gem:

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:

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

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.