ssh-agent-workspace 1.0.1 → 1.0.3

package/README.md

@@ -71,11 +71,13 @@ Your agent gets a **real interactive terminal** — not one-off exec commands. I
 
 ### Install
 
+npx auto-downloads and runs the latest version. Or install globally:
+
 ```bash
 npm install -g ssh-agent-workspace
 ```
 
-Or from source:
+From source:
 
 ```bash
 git clone https://github.com/ShiroNexo/ssh-agent-workspace.git
@@ -121,16 +123,18 @@ Your agent now has a persistent workspace on `prod`.
 
 ### Add to Your MCP Client
 
-#### OpenCode
+<details>
+<summary><b>OpenCode</b></summary>
 
-Add to `opencode.json`:
+Add to `~/.config/opencode/opencode.json`:
 
 ```json
 {
-  "mcpServers": {
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
     "workspace": {
-      "command": "node",
-      "args": ["/path/to/ssh-agent-workspace/dist/index.js"]
+      "type": "local",
+      "command": ["npx", "-y", "ssh-agent-workspace"]
     }
   }
 }
@@ -139,23 +143,25 @@ Add to `opencode.json`:
 Or via CLI:
 
 ```bash
-opencode mcp add workspace -- node /path/to/ssh-agent-workspace/dist/index.js
+opencode mcp add workspace -- npx -y ssh-agent-workspace
 ```
+</details>
 
-#### Claude Code
+<details>
+<summary><b>Claude Code</b></summary>
 
 ```bash
-claude mcp add workspace -- node /path/to/ssh-agent-workspace/dist/index.js
+claude mcp add workspace -- npx -y ssh-agent-workspace
 ```
 
-Or add to Claude Code config (`~/.config/claude-code/claude_code_config.json` or project `.mcp.json`):
+Or add to `~/.config/claude-code/claude_code_config.json` or project `.mcp.json`:
 
 ```json
 {
   "mcpServers": {
     "workspace": {
-      "command": "node",
-      "args": ["/path/to/ssh-agent-workspace/dist/index.js"],
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"],
       "autoApprove": [
         "mcp__workspace__connect",
         "mcp__workspace__exec",
@@ -172,33 +178,106 @@ Or add to Claude Code config (`~/.config/claude-code/claude_code_config.json` or
 }
 ```
 
-**Tip:** The `autoApprove` block lets the agent use those tools without asking you for permission each time. Add or remove tools based on your comfort level.
+> **Tip:** The `autoApprove` block lets the agent use those tools without asking permission each time. Add or remove tools based on your comfort level.
+</details>
+
+<details>
+<summary><b>Cursor</b></summary>
+
+Go to `Cursor Settings` → `MCP` → `New MCP Server`. Use this config:
+
+```json
+{
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
+}
+```
+</details>
+
+<details>
+<summary><b>Codex (OpenAI)</b></summary>
+
+```bash
+codex mcp add workspace -- npx -y ssh-agent-workspace
+```
+
+Or add to `~/.codex/config.toml`:
+
+```toml
+[mcp_servers.workspace]
+command = "npx"
+args = ["-y", "ssh-agent-workspace"]
+```
+</details>
+
+<details>
+<summary><b>Windsurf</b></summary>
 
-#### Cursor / Windsurf / Generic MCP
+Add to `~/.codeium/windsurf/mcp_config.json`:
 
 ```json
 {
   "mcpServers": {
     "workspace": {
-      "command": "node",
-      "args": ["/path/to/ssh-agent-workspace/dist/index.js"]
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
     }
   }
 }
 ```
+</details>
 
-#### If Using npx (no global install)
+<details>
+<summary><b>Copilot / VS Code</b></summary>
 
-Replace `"command": "node"` and `"args"` with:
+```json
+{
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
+}
+```
+</details>
+
+<details>
+<summary><b>Gemini CLI</b></summary>
+
+```bash
+gemini mcp add workspace npx -y ssh-agent-workspace
+```
+</details>
+
+<details>
+<summary><b>Cline</b></summary>
 
 ```json
 {
-  "command": "npx",
-  "args": ["-y", "ssh-agent-workspace"]
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
 }
 ```
+</details>
+
+<details>
+<summary><b>Qoder</b></summary>
+
+```bash
+qodercli mcp add workspace -- npx -y ssh-agent-workspace
+```
+</details>
 
-npx will download and run the latest version automatically.
+> **Using npx** means no global install needed. npx auto-downloads the latest version. If you installed globally (`npm install -g ssh-agent-workspace`), replace `"npx"` / `"-y"` / `"ssh-agent-workspace"` with `"ssh-agent-workspace"` as the command directly.
 
 Your agent now has a persistent workspace on `prod`. Running `cd /var/www` once means the agent stays there for every subsequent command.
 
@@ -255,7 +334,8 @@ No restart needed. Changes apply immediately.
 
 ## Tools (25)
 
-### Workspace (9)
+<details>
+<summary><b>Workspace (9 tools)</b></summary>
 
 | Tool | Description |
 |---|---|
@@ -268,45 +348,58 @@ No restart needed. Changes apply immediately.
 | `disconnect` | Close session. Optionally kill tmux or keep alive |
 | `list_hosts` | List `~/.ssh/config` aliases |
 | `list_sessions` | List active workspaces |
+</details>
 
-### File Transfer (3)
+<details>
+<summary><b>File Transfer (3 tools)</b></summary>
 
 | Tool | Description |
 |---|---|
 | `sftp_upload` | Upload file to remote |
 | `sftp_download` | Download file from remote |
 | `sftp_list` | List remote directory |
+</details>
 
-### Monitoring (3)
+<details>
+<summary><b>Monitoring (3 tools)</b></summary>
 
 | Tool | Description |
 |---|---|
 | `connection_status` | SSH liveness + tmux existence |
 | `health_check` | CPU / RAM / Disk / Load / Uptime |
 | `tail_log` | Log tail with optional follow |
+</details>
 
-### DevOps (4)
+<details>
+<summary><b>DevOps (6 tools)</b></summary>
 
 | Tool | Description |
 |---|---|
 | `deploy` | Upload → backup → chmod → chown → restart |
 | `backup` | tar.gz archive → download → cleanup |
 | `sync` | Rsync-lite via SFTP (bidirectional, dry-run) |
-| `ssh_tunnel_open` / `ssh_tunnel_list` / `ssh_tunnel_close` | Port forwarding + SOCKS5 |
+| `ssh_tunnel_open` | Local port forward or SOCKS5 proxy |
+| `ssh_tunnel_list` | List active tunnels |
+| `ssh_tunnel_close` | Close tunnel, free port |
+</details>
 
-### Cluster & Queries (2)
+<details>
+<summary><b>Cluster & Queries (2 tools)</b></summary>
 
 | Tool | Description |
 |---|---|
 | `group_exec` | Run command across multiple workspaces (parallel/sequential) |
 | `db_query` | Read-only MySQL / PostgreSQL / MongoDB via SSH |
+</details>
 
-### Runtime Config (2)
+<details>
+<summary><b>Runtime Config (2 tools)</b></summary>
 
 | Tool | Description |
 |---|---|
 | `tools_config` | Enable/disable tools at runtime |
 | `host_security` | Per-host read-only, command allow/denylist |
+</details>
 
 **Full reference:** [`docs/TOOLS.md`](docs/TOOLS.md) | **Security:** [`docs/SECURITY.md`](docs/SECURITY.md)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-agent-workspace",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Persistent SSH workspaces for AI agents. Stateful tmux-backed sessions that survive reconnects, restarts, and network drops — with runtime security and tool configuration.",
   "type": "module",
   "main": "dist/index.js",