Rails MCP Server

🚀 Rails MCP 服務器

Rails MCP 服務器是一款專門用於與支持 Model Context Protocol (MCP) 的大語言模型 (LLM) 客戶端集成的工具。它藉助一系列預定義工具，實現對 Rails 項目的分析與操作，有效提升開發效率。

🚀 快速開始

Rails MCP 服務器能與支持 MCP 協議的大語言模型客戶端集成，通過預定義工具對 Rails 項目進行分析和操作。以下是使用前的安裝與配置步驟。

📦 安裝指南

安裝依賴

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 方法執行，具體如下：

項目分析

# 分析整個 Rails 項目
tool_calls :analyze_rails_project, project_path: "."

# 列出所有可用工具
tool_calls :list_tools

數據庫 Schema 分析

# 獲取完整的數據庫模式
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 獲取參與方式。