Rails MCP Server

🚀 Rails MCP サーバー

Rails MCP サーバーは、Model Context Protocol (MCP) をサポートする大規模言語モデル (LLM) クライアントとの統合を目的として設計されたツールです。一連の事前定義されたツールを通じて Rails プロジェクトの分析と操作を行い、開発効率を向上させます。

🚀 クイックスタート

Rails MCP サーバーを使用するには、まずインストールと設定を行い、その後サーバーを起動してから各種ツールを利用できます。以下に詳細な手順を説明します。

✨ 主な機能

• 複数の事前定義されたツールを通じて Rails プロジェクトの分析と操作を行うことができます。
• MCP プロトコルを介して、LLM クライアントとの統合が可能です。
• 標準入出力 (STDIO) モードと HTTP モードの両方をサポートしています。

📦 インストール

依存関係のインストール

1. リポジトリをクローンします：

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

2. Bundler を使用して依存関係をインストールします：

   bundle install
   

サーバーの起動

1. 必要に応じてモードを選択して起動します：

   • 標準入出力 (STDIO) モード（デフォルト）：

     bin/rails-mcp-server
     

   • HTTP モード：

     bin/rails-mcp-server --mode http
     

💻 使用例

基本的な使用法

標準ツールの呼び出し

すべてのツールは MCP プロトコルの tool_calls メソッドを通じて実行されます。具体的な例を以下に示します。

1. プロジェクト分析

# 全体の Rails プロジェクトを分析する
tool_calls :analyze_rails_project, project_path: "."

# 利用可能なすべてのツールをリストする
tool_calls :list_tools

2. データベーススキーマ分析

# 完全なデータベーススキーマを取得する
tool_calls :get_schema

# 特定のテーブルの詳細情報を取得する
tool_calls :get_schema, table_name: "users"

高度な使用法

環境設定分析

# 環境設定ファイルを分析する
tool_calls :analyze_environment_config

📚 ドキュメント

LLM クライアントとの統合

MCP プロトコルをサポートするクライアント（例：Claude Desktop）を使用するには、以下の手順に従ってください。

1. Rails MCP サーバーを起動します。
2. クライアントをサーバーに接続します。
3. 利用可能なツールを使用してプロジェクトの分析を行います。

テストとデバッグ

MCP インスペクターの使用

MCP インスペクターは、テストとデバッグ用に設計された開発者ツールです。使用手順は以下の通りです。

1. インスペクターをインストールします：

   npm install -g @modelcontextprotocol/inspector
   

2. インスペクターを起動し、Rails MCP サーバーに接続します：

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

3. ブラウザでデフォルトのアドレス（http://localhost:6274）にアクセスし、対話型の呼び出しとデバッグを開始します。

📄 ライセンス

Rails MCP サーバーは MIT ライセンスに基づいています。詳細は LICENSE ファイルを参照してください。

🤝 貢献ガイド

貢献を歓迎します！ 参加方法については CONTRIBUTING.md を参照してください。