Rails MCP Server

🚀 Rails MCP Server

Rails MCP Server is a tool designed for integrating with large language model (LLM) clients that support the Model Context Protocol (MCP). It enables the analysis and operation of Rails projects through a series of predefined tools, thereby enhancing development efficiency.

🚀 Quick Start

✨ Features

Rails MCP Server allows for the analysis and operation of Rails projects via a set of predefined tools, enhancing development efficiency by integrating with MCP - supported LLM clients.

📦 Installation

Install Dependencies

1. Clone the repository:

git clone https://github.com/maquina-app/rails-mcp-server.git
cd rails-mcp-server

2. Install dependencies using Bundler:

bundle install

Start the Server

1. Start the server in the desired mode:

• Standard Input/Output (STDIO) mode (default):

bin/rails-mcp-server

• HTTP mode:

bin/rails-mcp-server --mode http

💻 Usage Examples

Basic Usage

All tools are executed through the tool_calls method of the MCP protocol.

Project Analysis

# Analyze the entire Rails project
tool_calls :analyze_rails_project, project_path: "."

# List all available tools
tool_calls :list_tools

Database Schema Analysis

# Get the complete database schema
tool_calls :get_schema

# Get detailed information about a specific table
tool_calls :get_schema, table_name: "users"

Advanced Usage

Environment Configuration Analysis

# Analyze the environment configuration file
tool_calls :analyze_environment_config

📚 Documentation

Integration with LLM Clients

To use a client that supports the MCP protocol (e.g., Claude Desktop), follow these steps:

1. Start the Rails MCP Server.
2. Connect the client to the server.
3. Use the available tools for project analysis.

Testing and Debugging

Using the MCP Inspector

The MCP Inspector is a developer tool designed for testing and debugging. Here's how to use it:

1. Install the inspector:

npm install -g @modelcontextprotocol/inspector

2. Start the inspector and connect to the Rails MCP Server:

npx @modelcontextprotocol/inspector /path/to/rails-mcp-server

3. Access the default address (http://localhost:6274) in your browser to start interactive calls and debugging.

📄 License

Rails MCP Server is licensed under the MIT License. See the LICENSE file for details.

🔗 Contribution Guide

Contributions are welcome! Please refer to CONTRIBUTING.md for ways to participate.