MCP Server Ssh Rails Runner

🚀 SSH Rails Runner MCP服務器

SSH Rails Runner MCP服務器是一個藉助SSH實現遠程安全執行Rails控制檯命令的工具。它為部署環境中的Rails應用程序提供了進行只讀操作和嚴格管理的突變操作的能力，讓數據處理和分析工作更加便捷高效。與Cursor配合使用時，能發揮出更強大的功能，可利用Cursor Composer拉取Rails模型文件作為上下文，然後使用相關工具對數據庫進行更改，無需通過複雜的管理員UI。

🚀 快速開始

本服務器與Cursor配合使用效果更佳。你可以利用Cursor Composer拉取你的Rails模型文件作為上下文，然後使用execute_read_only、dry_run_mutate和execute_mutate工具對數據庫進行更改，無需通過複雜的管理員UI來完成數據處理和分析工作。

示例展示

✨ 主要特性

• 通過SSH遠程執行Rails控制檯命令
• 安全的只讀操作
• 突變操作的幹運行能力
• 執行經過批准的突變操作
• 代碼片段的資源管理

📦 安裝指南

npm install
npm run build

📚 詳細文檔

配置說明

設置以下環境變量：

SSH_HOST=your.remote.host
SSH_USER=your_ssh_user
SSH_PRIVATE_KEY_PATH=your_SSH_PRIVATE_KEY_PATH
RAILS_WORKING_DIR=/path/to/rails/app

與Claude Desktop配合使用

在你的Claude Desktop配置中添加：

{
  "mcpServers": {
    "ssh-rails-runner": {
      "command": "npx",
      "args": ["mcp-server-ssh-rails-runner"],
      "env": {
        "SSH_HOST": "your.remote.host",
        "SSH_USER": "your_ssh_user",
        "SSH_PRIVATE_KEY_PATH": "your_SSH_PRIVATE_KEY_PATH",
        "RAILS_WORKING_DIR": "/path/to/rails/app/root",
        "PROJECT_NAME_AS_CONTEXT": "顯示在工具描述中以幫助LLM描述我們正在處理的Rails項目的名稱。",
        "CODE_SNIPPET_FILE_DIRECTORY": "/path/to/store/code/snippets/locally"
      }
    }
  }
}

如果未提供CODE_SNIPPET_FILE_DIRECTORY，代碼片段將存儲在臨時目錄（例如：/tmp/mcp-ssh-rails-runner-code-snippets）。PROJECT_NAME_AS_CONTEXT是可選的，並且有助於識別項目上下文以幫助描述工具。

可用工具

服務器現在使用準備 -> 執行工作流程：

mcp_ssh_rails_runner_prepare_code_snippet

• 參數：name（字符串，文件名），type（枚舉："readOnly" | "mutate"），code（字符串，Ruby代碼），description（字符串，可選）。
• 功能：將提供的Ruby代碼保存到本地文件code_snippet_<name>.json，標記為只讀或突變，並打開該文件以供審核。
• 返回：創建snippet的file:// URI。

mcp_ssh_rails_runner_execute_code_snippet_read_only

• 參數：uri（字符串，file:// URI來自prepareCodeSnippet）。
• 功能：從URI讀取代碼片段，驗證其標記為readOnly，執行代碼的安全檢查，並運行它。
• 返回：Rails命令的輸出。

mcp_ssh_rails_runner_execute_code_snippet_mutate

• 參數：uri（字符串，file:// URI來自prepareCodeSnippet）。
• 功能：從URI讀取代碼片段，驗證其標記為mutate，執行代碼的安全檢查，並運行它。
• 返回：Rails命令的輸出。

安全注意事項

⚠️ 重要提示

• 確保SSH連接是加密的（例如使用SSH協議版本2）。
• 避免在不受信任的網絡中傳輸敏感數據。
• 在處理代碼片段時，始終進行嚴格的輸入驗證和 sanitization。
• 保持服務器和客戶端軟件更新以防止已知的安全漏洞。

📄 許可證

本項目採用MIT許可證。