mcp-ssh-vps 0.4.1__py3-none-any.whl

mcp_ssh_vps-0.4.1.dist-info/METADATA

@@ -0,0 +1,482 @@
+Metadata-Version: 2.4
+Name: mcp-ssh-vps
+Version: 0.4.1
+Summary: MCP server for managing VPS via SSH - gives AI agents secure access to remote servers
+Author-email: LuxVTZ <luxvtz@example.com>
+Maintainer: LuxVTZ
+License: MIT
+Project-URL: Homepage, https://github.com/LuxVTZ/sshmcp
+Project-URL: Documentation, https://github.com/LuxVTZ/sshmcp#readme
+Project-URL: Repository, https://github.com/LuxVTZ/sshmcp
+Project-URL: Issues, https://github.com/LuxVTZ/sshmcp/issues
+Keywords: mcp,ssh,vps,ai,automation,claude,llm,model-context-protocol
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: paramiko>=3.0.0
+Requires-Dist: structlog>=24.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: click>=8.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.14.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=24.0.0; extra == "dev"
+Requires-Dist: ruff>=0.8.0; extra == "dev"
+Requires-Dist: mypy>=1.13.0; extra == "dev"
+Provides-Extra: totp
+Requires-Dist: pyotp>=2.9.0; extra == "totp"
+Requires-Dist: qrcode>=7.0; extra == "totp"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.5.0; extra == "docs"
+Requires-Dist: mkdocs-material>=9.5.0; extra == "docs"
+Requires-Dist: pymdown-extensions>=10.0.0; extra == "docs"
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://img.shields.io/pypi/v/mcp-ssh-vps?color=blue&label=PyPI" alt="PyPI">
+  <img src="https://img.shields.io/pypi/pyversions/mcp-ssh-vps" alt="Python">
+  <img src="https://img.shields.io/github/license/LuxVTZ/sshmcp" alt="License">
+  <img src="https://img.shields.io/pypi/dm/mcp-ssh-vps?color=green" alt="Downloads">
+</p>
+
+<h1 align="center">🔐 SSH MCP Server</h1>
+
+<p align="center">
+  <b>Give AI agents secure access to your VPS servers via SSH</b><br>
+  Execute commands, transfer files, manage processes — all through Model Context Protocol
+</p>
+
+<p align="center">
+  <a href="#-quick-start">Quick Start</a> •
+  <a href="#-features">Features</a> •
+  <a href="#-ide-integration">IDE Integration</a> •
+  <a href="#-tools-reference">Tools</a> •
+  <a href="#-security">Security</a>
+</p>
+
+---
+
+## 🚀 Quick Start
+
+### Install
+
+```bash
+# Via pip
+pip install mcp-ssh-vps
+
+# Via uvx (recommended for MCP)
+uvx mcp-ssh-vps
+```
+
+### Add Your First Server
+
+```bash
+# Interactive setup
+uvx mcp-ssh-vps --help
+
+# Or use the CLI
+sshmcp-cli server add --name prod --host 192.168.1.100 --user deploy
+sshmcp-cli server test prod
+```
+
+### Connect to Your AI Agent
+
+Add to your AI IDE config and start managing servers with natural language!
+
+```
+"Deploy my app to the production server"
+"Check disk space on all servers"
+"Restart nginx on web1 and web2"
+```
+
+---
+
+## ✨ Features
+
+| Feature | Description |
+|---------|-------------|
+| 🖥️ **Execute Commands** | Run any shell command on remote servers |
+| 📁 **File Operations** | Read, write, and list files via SFTP |
+| ⚙️ **Process Management** | Control systemd, pm2, supervisor services |
+| 🏷️ **Server Tags** | Group servers with tags for batch operations |
+| 🔄 **Batch Execution** | Run commands on multiple servers in parallel |
+| 🔒 **Security Profiles** | Strict, moderate, or full access levels |
+| 📝 **Audit Logging** | Track all operations for compliance |
+| 🔑 **SSH Keys & Passwords** | Support for both authentication methods |
+
+---
+
+## 🔌 IDE Integration
+
+> **Note:** Config is auto-loaded from `~/.sshmcp/machines.json` by default. No env variables required!
+
+### Claude Code
+
+```bash
+claude mcp add ssh-vps -- uvx mcp-ssh-vps
+```
+
+Or add to `~/.claude.json`:
+
+```json
+{
+  "mcpServers": {
+    "ssh-vps": {
+      "command": "uvx",
+      "args": ["mcp-ssh-vps"]
+    }
+  }
+}
+```
+
+---
+
+### Factory Droid
+
+```bash
+droid mcp add ssh-vps "uvx mcp-ssh-vps"
+```
+
+Or add to `~/.factory/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "ssh-vps": {
+      "command": "uvx",
+      "args": ["mcp-ssh-vps"]
+    }
+  }
+}
+```
+
+---
+
+### Cursor
+
+Add to `~/.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "ssh-vps": {
+      "command": "uvx",
+      "args": ["mcp-ssh-vps"]
+    }
+  }
+}
+```
+
+---
+
+### Qwen Code
+
+```bash
+qwen mcp add ssh-vps uvx mcp-ssh-vps
+```
+
+Or add to `~/.qwen/settings.json`:
+
+```json
+{
+  "mcpServers": {
+    "ssh-vps": {
+      "command": "uvx",
+      "args": ["mcp-ssh-vps"]
+    }
+  }
+}
+```
+
+---
+
+### Claude Desktop
+
+Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
+
+```json
+{
+  "mcpServers": {
+    "ssh-vps": {
+      "command": "uvx",
+      "args": ["mcp-ssh-vps"]
+    }
+  }
+}
+```
+
+---
+
+### VS Code + Continue
+
+Add to `.continue/config.json`:
+
+```json
+{
+  "experimental": {
+    "modelContextProtocolServers": [
+      {
+        "transport": {
+          "type": "stdio",
+          "command": "uvx",
+          "args": ["mcp-ssh-vps"]
+        }
+      }
+    ]
+  }
+}
+```
+
+---
+
+### Windsurf
+
+Add to `~/.codeium/windsurf/mcp_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "ssh-vps": {
+      "command": "uvx",
+      "args": ["mcp-ssh-vps"]
+    }
+  }
+}
+```
+
+---
+
+### OpenAI Codex CLI
+
+```bash
+codex --mcp-config '{"ssh-vps": {"command": "uvx", "args": ["mcp-ssh-vps"]}}'
+```
+
+---
+
+### Any MCP-Compatible Client
+
+Generic stdio configuration:
+
+```json
+{
+  "command": "uvx",
+  "args": ["mcp-ssh-vps"]
+}
+```
+
+> **Custom config path?** Add `"env": {"SSHMCP_CONFIG_PATH": "/custom/path.json"}`
+
+---
+
+## 🛠️ Tools Reference
+
+### Command Execution
+
+| Tool | Description | Example |
+|------|-------------|---------|
+| `execute_command` | Run command on server | `execute_command("prod", "docker ps")` |
+| `execute_on_multiple` | Run on multiple servers | `execute_on_multiple(["*"], "uptime")` |
+
+### Server Management
+
+| Tool | Description | Example |
+|------|-------------|---------|
+| `list_servers` | List all servers | `list_servers()` or `list_servers(tag="web")` |
+| `add_server` | Add new server | `add_server("web1", "1.2.3.4", "root")` |
+| `remove_server` | Remove server | `remove_server("old-server")` |
+| `test_connection` | Test SSH connection | `test_connection("prod")` |
+
+### File Operations
+
+| Tool | Description | Example |
+|------|-------------|---------|
+| `read_file` | Read remote file | `read_file("prod", "/var/log/app.log")` |
+| `upload_file` | Upload file | `upload_file("prod", "/tmp/script.sh", "#!/bin/bash\n...")` |
+| `list_files` | List directory | `list_files("prod", "/var/log")` |
+
+### Process Management
+
+| Tool | Description | Example |
+|------|-------------|---------|
+| `manage_process` | Control services | `manage_process("prod", "restart", "nginx")` |
+
+### Help & Info
+
+| Tool | Description | Example |
+|------|-------------|---------|
+| `get_help` | Get documentation | `get_help("examples")` |
+| `get_allowed_commands` | View security config | `get_allowed_commands("prod")` |
+| `get_server_info` | Server details | `get_server_info("prod")` |
+
+---
+
+## 🏷️ Server Tags & Batch Operations
+
+### Add servers with tags
+
+```python
+add_server("web1", "192.168.1.10", "deploy", tags=["production", "web"])
+add_server("web2", "192.168.1.11", "deploy", tags=["production", "web"])
+add_server("db1", "192.168.1.20", "deploy", tags=["production", "database"])
+```
+
+### Filter by tag
+
+```python
+list_servers(tag="web")           # Only web servers
+list_servers(tag="production")    # All production servers
+```
+
+### Execute on tagged servers
+
+```python
+execute_on_multiple(["tag:web"], "nginx -t")           # All web servers
+execute_on_multiple(["tag:production"], "uptime")      # All production
+execute_on_multiple(["*"], "df -h")                    # ALL servers
+```
+
+---
+
+## 🔒 Security
+
+### Security Profiles
+
+| Profile | Allowed Commands | Use Case |
+|---------|-----------------|----------|
+| `strict` | `git`, `ls`, `cat`, `df`, `uptime` | Read-only monitoring |
+| `moderate` | + `docker`, `npm`, `systemctl`, `pm2` | Standard DevOps |
+| `full` | All commands (except `rm -rf /`) | Full access |
+
+### Set security level
+
+```python
+add_server("prod", "1.2.3.4", "root", security_level="full")
+```
+
+### Audit Logging
+
+All commands are logged with timestamps, user, and results:
+
+```
+2024-01-15T10:30:00Z | prod | root | docker ps | exit_code=0 | 150ms
+```
+
+---
+
+## 📁 Configuration
+
+### Config Location
+
+```
+~/.sshmcp/machines.json
+```
+
+### Example Config
+
+```json
+{
+  "machines": [
+    {
+      "name": "production",
+      "host": "192.168.1.100",
+      "port": 22,
+      "user": "deploy",
+      "auth": {
+        "type": "key",
+        "key_path": "~/.ssh/id_rsa"
+      },
+      "security": {
+        "allowed_commands": [".*"],
+        "forbidden_commands": [".*rm\\s+-rf\\s+/$"],
+        "timeout_seconds": 120
+      },
+      "tags": ["production", "web"],
+      "description": "Main production server"
+    }
+  ]
+}
+```
+
+### Environment Variable
+
+```bash
+export SSHMCP_CONFIG_PATH=/custom/path/machines.json
+```
+
+---
+
+## 📖 Usage Examples
+
+### Check status of all servers
+
+```
+User: Check the status of all my servers
+AI: I'll run uptime on all configured servers...
+
+execute_on_multiple(["*"], "uptime && df -h | head -5")
+```
+
+### Deploy application
+
+```
+User: Deploy the latest code to production
+AI: I'll pull the latest changes and restart the service...
+
+execute_command("prod", "cd /app && git pull origin main")
+execute_command("prod", "npm install --production")
+execute_command("prod", "pm2 restart all")
+```
+
+### Debug server issues
+
+```
+User: Why is the web server slow?
+AI: Let me check system resources and logs...
+
+execute_command("web1", "top -bn1 | head -20")
+execute_command("web1", "tail -50 /var/log/nginx/error.log")
+execute_command("web1", "free -m && df -h")
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+```bash
+git clone https://github.com/LuxVTZ/sshmcp.git
+cd sshmcp
+pip install -e ".[dev]"
+pytest
+```
+
+---
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+---
+
+<p align="center">
+  Made with ❤️ for the AI agent ecosystem<br>
+  <a href="https://pypi.org/project/mcp-ssh-vps/">PyPI</a> •
+  <a href="https://github.com/LuxVTZ/sshmcp">GitHub</a> •
+  <a href="https://github.com/LuxVTZ/sshmcp/issues">Issues</a>
+</p>

mcp_ssh_vps-0.4.1.dist-info/RECORD

@@ -0,0 +1,47 @@
+mcp_ssh_vps-0.4.1.dist-info/licenses/LICENSE,sha256=ppiqeMeZlSPENPupmFrUYQ4hLLBVSRXCP-d-fce7in4,1072
+sshmcp/__init__.py,sha256=COyOmnYje5IWNGRx6giHMqj_aosq8fy9HskrEwILMb4,83
+sshmcp/cli.py,sha256=gHaKkgBHSN3Zlf3gDMjYqfSxfwYIR_mlGW3yN3R7lPU,13687
+sshmcp/config.py,sha256=AwpjGSrUvZTbhtFzs-xZu2P-bc7SfVWh6GYBu2dLhdk,3924
+sshmcp/server.py,sha256=vVpsN2xBM-gXesaNSGaAII0CjK0HojKkfusLv31YnD0,17363
+sshmcp/core/__init__.py,sha256=AiFSxn9RBB0f_6bBsDP8Y8WDyPgU38W_2SImrkMqQ6s,174
+sshmcp/core/container.py,sha256=83MUkbmI4pI4pcdadUAsUuYU1mKugR20CQnJsGPyvSI,8300
+sshmcp/models/__init__.py,sha256=mSJBlHEiiBlB43IoJiD4ozj4YWpsGe-tJ0ntSACTPgE,386
+sshmcp/models/command.py,sha256=HgEqmgvUsTiGsrWfAXIty9QTxaH366LouM9Eg5jJS7o,2447
+sshmcp/models/file.py,sha256=1uHk9P8SAbDLmA_jwTah7kYfA5gXUYILyliTLonSjng,3600
+sshmcp/models/machine.py,sha256=CmO_JW_hZetSqk73AeoZTPcw0UL9-6Lc5CSo1LwE_VA,4732
+sshmcp/monitoring/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sshmcp/monitoring/alerts.py,sha256=rnpqBWCC2mL7_2kP9m_YKp9rwZb1ADoGBLi1D1mGSSY,14239
+sshmcp/prompts/__init__.py,sha256=-Zf5OF4pXqrJr-y7TmlUBJxHNdvojthhk5KLljeabwI,249
+sshmcp/prompts/backup.py,sha256=FH7KM4Q4WUiPjAaBMY1mjSXCpK84mUcZURgXjmTxp88,4796
+sshmcp/prompts/deploy.py,sha256=NzLDE0I7E0zU1YLZc0VVqyCEFkNErlJnFGX3BNy7Jek,3388
+sshmcp/prompts/monitor.py,sha256=2_XWUt1ciqAcx0uBhwyOAt1pCwzQQ8fG4P812bLx-SA,3452
+sshmcp/resources/__init__.py,sha256=KFrZR23kZ2RT6uHKMVTW5uAjo_aCN3WGSXnRXmEbmsM,234
+sshmcp/resources/logs.py,sha256=dir6kisW9W9vPtwGsUZsqdSALRvN4Bk2t4t9-4BmxAY,2915
+sshmcp/resources/metrics.py,sha256=Al_yIm9y1f8c4oPChYTvffBVs-CzKcrZQm2c0mFtNzo,5756
+sshmcp/resources/status.py,sha256=aHZNm0rdrl2a9zQcppqYAsy1AePVYdVNZXGmhSzZ_XI,4506
+sshmcp/security/__init__.py,sha256=LAqP2FkGXt5CW7qQLfwAzHU83r__hKtgmyXp9No3WlU,311
+sshmcp/security/audit.py,sha256=Jezna19k9OH_DZCoec5tCJpTWTf0TarnP2yco84g-mw,8288
+sshmcp/security/rate_limiter.py,sha256=ddDMfU_mbIgOwz8OKr2XsfcgorDINiAfE1ABGIsj_KY,6372
+sshmcp/security/totp.py,sha256=tO1NhllxWmu4oYqC5pcrCCWzAlXSSRFW5elv-W5SAaQ,10308
+sshmcp/security/validator.py,sha256=8kOkLoLh16SUaKsRI2AN7goWFiQYeBMP-ld-ROny--s,6424
+sshmcp/security/whitelist.py,sha256=yuTvMgxiv-fQ3iSPWxWGJrsTVHFlwAkZOBu2Viz7ht8,4743
+sshmcp/ssh/__init__.py,sha256=Ck8L6zoDtuvjkU-DPV7mqUWTIJDYovg7r-6K6ZcO9wo,188
+sshmcp/ssh/async_client.py,sha256=puiOfPRVsDBxiTR7CHwMPQNnxvqZytOmyCCCydRgBz0,6904
+sshmcp/ssh/client.py,sha256=lfqQ8PSDisSqcP7E2YHHRxv4Xk2MNuuSSKwMQCqlX1w,14226
+sshmcp/ssh/executor.py,sha256=vvEMqMHx-hdxEA3FzbW3Ek2dBWS0C5Ij5RU8NW3Y0PY,1957
+sshmcp/ssh/forwarding.py,sha256=bL-GqWH--oq_fTWhXKjeQyIM_KUuRfON8cRu3knhhYQ,11487
+sshmcp/ssh/pool.py,sha256=5NKlsIH97_b5RGpj0K4bu16flKac2eLBN0ZhsoLYR00,10967
+sshmcp/ssh/shell.py,sha256=cHbqkW6TznP6sQWEZYCp1gLU9UYLqDzjStm1j2wtCMw,14301
+sshmcp/ssh/transfer.py,sha256=2atMkC3oJHmI7Cmrlb-rmTwdxWJxWiPfcOUyJhbcl-I,15052
+sshmcp/tools/__init__.py,sha256=NWHpxtrS6oitZNY9LKz6uY_QZ3gNa9wAaRLjs64GLRg,317
+sshmcp/tools/commands.py,sha256=ork58xsVPj5_uWojT6OXbkJvgldN-0865aFMfmU0Sjw,7135
+sshmcp/tools/files.py,sha256=7ywoi9S9xz-bPOr9NQNSz245zRfJ8A8_UA1zCFCzDvo,6342
+sshmcp/tools/helpers.py,sha256=BA9Qs5nOeAvWG41V7fZSSP1KsfFMPgwBw2ccVWsMD4Q,12004
+sshmcp/tools/history.py,sha256=PGfDYTseTjPHGGs1S2WvCsVPwxAUF213nR0uGQqUGBE,10906
+sshmcp/tools/processes.py,sha256=sGVufPMjgjt0nDwcwTzuSFLVnWVA4HexmS0-w41sMuA,6429
+sshmcp/tools/servers.py,sha256=Gp-vgFJgd30pd_VxvXFiaTr5un1TtYX7g_HGzUsywTg,13842
+mcp_ssh_vps-0.4.1.dist-info/METADATA,sha256=7DRnqSW_bziZwEl1AO0dV6WoEkFf4MGIJHwOex7Korw,10808
+mcp_ssh_vps-0.4.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mcp_ssh_vps-0.4.1.dist-info/entry_points.txt,sha256=fU7-NaKaiAoXlyQoLIIKapL4qm9BZByuLjnrOJC-U-8,108
+mcp_ssh_vps-0.4.1.dist-info/top_level.txt,sha256=otSZGi7nsFnamz7vfHqrlwx188M1FsniIEXwNr9H4o4,7
+mcp_ssh_vps-0.4.1.dist-info/RECORD,,

mcp_ssh_vps-0.4.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mcp_ssh_vps-0.4.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+mcp-ssh-vps = sshmcp.server:main
+sshmcp = sshmcp.server:main
+sshmcp-cli = sshmcp.cli:main

mcp_ssh_vps-0.4.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 SSH MCP Project
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcp_ssh_vps-0.4.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+sshmcp

sshmcp/__init__.py

@@ -0,0 +1,3 @@
+"""SSH MCP Server - MCP server for managing VPS via SSH."""
+
+__version__ = "0.1.0"