MCP SSH Manager

# Installation Guide for MCP SSH Manager ## 📋 Prerequisites - **Node.js** (v18 or higher) - [Download](https://nodejs.org/) - **Claude Code CLI** - [Installation Guide](https://claude.ai/code) - **Bash** (4.0+) - Pre-installed on macOS/Linux - **Git** - For cloning the repository Verify installations: ```bash node --version # Should show v18.x.x or higher claude --version # Should show Claude Code version bash --version # Should show version 4.0 or higher ``` ## 🚀 Quick Installation ```bash # 1. Clone the repository git clone https://github.com/bvisible/mcp-ssh-manager.git cd mcp-ssh-manager # 2. Install dependencies npm install # 3. Install the Bash CLI cd cli && ./install.sh cd .. # 4. Install to Claude Code claude mcp add ssh-manager node $(pwd)/src/index.js ``` ## 🔧 Server Configuration ### Interactive Mode (Recommended) ```bash # Launch interactive menu ssh-manager # Choose "Server Management" → "Add New Server" # Follow the guided wizard ``` ### Direct Commands ```bash ssh-manager server add # Add new server ssh-manager server list # List all servers ssh-manager server test # Test connection ssh-manager server remove # Remove server ``` ### Manual Configuration Edit the `.env` file directly: ```env # Pattern: SSH_SERVER_[NAME]_[PROPERTY] # Password authentication SSH_SERVER_PROD1_HOST=example.com SSH_SERVER_PROD1_USER=admin SSH_SERVER_PROD1_PASSWORD=secure_password SSH_SERVER_PROD1_PORT=22 SSH_SERVER_PROD1_DESCRIPTION="Production Server" # SSH key authentication (recommended) SSH_SERVER_DEV1_HOST=dev.example.com SSH_SERVER_DEV1_USER=developer SSH_SERVER_DEV1_KEYPATH=~/.ssh/id_rsa SSH_SERVER_DEV1_PORT=22 SSH_SERVER_DEV1_DEFAULT_DIR=/var/www ``` ## ✅ Verification ### 1. Check CLI Installation ```bash ssh-manager --version # Should show: SSH Manager CLI v2.0.0 ``` ### 2. Check MCP Installation ```bash claude mcp list # Should show: ssh-manager ``` ### 3. Test in Claude Code Open Claude Code and try: ``` "List all SSH servers" "Connect to production server" "Upload file to staging" ``` ## 🛠️ Troubleshooting ### CLI not found ```bash # Add to your PATH echo 'export PATH="$PATH:/usr/local/bin"' >> ~/.bashrc source ~/.bashrc ``` ### Servers not showing ```bash # Check .env file location export SSH_MANAGER_ENV="$(pwd)/.env" ssh-manager server list ``` ### Permission denied ```bash # Fix SSH key permissions chmod 600 ~/.ssh/your_key ``` ### MCP tools not available ```bash # Restart Claude Code and re-add claude mcp remove ssh-manager claude mcp add ssh-manager node $(pwd)/src/index.js ``` ## 🌍 Environment Variables Set these in your shell profile (`~/.bashrc` or `~/.zshrc`): ```bash # Point to your .env file export SSH_MANAGER_ENV="/path/to/your/.env" # Optional: Set default log level export SSH_LOG_LEVEL="INFO" ``` ## 📦 Project Scope Installation To share with your team: ```bash # Create project configuration claude mcp add ssh-manager --scope project node $(pwd)/src/index.js ``` This creates `.mcp.json` that can be committed to Git. ## 🗑️ Uninstallation ```bash # Remove from Claude Code claude mcp remove ssh-manager # Uninstall CLI sudo rm /usr/local/bin/ssh-manager # Remove configuration rm -rf ~/.ssh-manager ``` ## 📚 Next Steps After installation: 1. Add your servers using the interactive wizard 2. Test connections: `ssh-manager server test` 3. Try quick SSH: `ssh-manager ssh servername` 4. Explore features: `ssh-manager --help` For more information, see the [README](README.md).