ssh-agent-workspace 1.0.0 → 1.0.2

package/README.md

@@ -64,7 +64,6 @@ Your agent gets a **real interactive terminal** — not one-off exec commands. I
 | **Prompt detection** | Deterministic custom PS1 | Blind sleep + guess |
 | **Per-host security** | runtime `host_security` tool | Env vars only, restart required |
 | **Tool management** | runtime `tools_config` (persistent) | None or env vars |
-| **Token efficiency** | ~2,800 tokens (25 tools) | ~43,500 tokens (37 tools) |
 
 ---
 
@@ -72,41 +71,202 @@ 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/dynamic-ssh-mcp.git
-cd dynamic-ssh-mcp
+git clone https://github.com/ShiroNexo/ssh-agent-workspace.git
+cd ssh-agent-workspace
 npm install && npm run build
 ```
 
-### Configure MCP Client
+### Setup Your SSH Config
+
+Hosts must be defined in `~/.ssh/config`:
+
+```
+Host prod
+  HostName 10.0.0.5
+  User deploy
+  IdentityFile ~/.ssh/id_ed25519
+
+Host staging
+  HostName 10.0.0.10
+  User deploy
+  IdentityFile ~/.ssh/id_ed25519
+
+Host internal
+  HostName 172.16.0.50
+  User admin
+  ProxyJump bastion
+
+Host bastion
+  HostName jump.example.com
+  User jumpuser
+```
+
+### Try It
+
+```
+> connect host=prod
+→ { session_id: "sess_abc", tmux_session: "mcp_prod_x1y2z3" }
+```
+
+Your agent now has a persistent workspace on `prod`.
+
+---
+
+### Add to Your MCP Client
+
+Pick your client:
+
+#### OpenCode
+
+Add to `~/.config/opencode/opencode.json`:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "workspace": {
+      "type": "local",
+      "command": ["npx", "-y", "ssh-agent-workspace"]
+    }
+  }
+}
+```
+
+Or via CLI:
+
+```bash
+opencode mcp add workspace -- npx -y ssh-agent-workspace
+```
+
+#### Claude Code
+
+```bash
+claude mcp add workspace -- npx -y ssh-agent-workspace
+```
+
+Or add to `~/.config/claude-code/claude_code_config.json` or project `.mcp.json`:
 
 ```json
 {
   "mcpServers": {
     "workspace": {
-      "command": "node",
-      "args": ["/path/to/dist/index.js"],
-      "env": {
-        "MCP_SSH_RESTORE_SESSIONS": "true"
-      }
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"],
+      "autoApprove": [
+        "mcp__workspace__connect",
+        "mcp__workspace__exec",
+        "mcp__workspace__send_input",
+        "mcp__workspace__read_output",
+        "mcp__workspace__list_hosts",
+        "mcp__workspace__list_sessions",
+        "mcp__workspace__sftp_upload",
+        "mcp__workspace__sftp_download",
+        "mcp__workspace__sftp_list"
+      ]
     }
   }
 }
 ```
 
-### First session
+**Tip:** The `autoApprove` block lets the agent use those tools without asking permission each time. Add or remove tools based on your comfort level.
+
+#### Cursor
 
+Go to `Cursor Settings` → `MCP` → `New MCP Server`. Use this config:
+
+```json
+{
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
+}
 ```
-> connect host=prod
-→ { session_id: "sess_abc", tmux_session: "mcp_prod_x1y2z3" }
+
+#### Codex (OpenAI)
+
+```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"]
+```
+
+#### Windsurf
+
+Add to `~/.codeium/windsurf/mcp_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
+}
+```
+
+#### Copilot / VS Code
+
+```json
+{
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
+}
+```
+
+#### Gemini CLI
+
+```bash
+gemini mcp add workspace npx -y ssh-agent-workspace
+```
+
+#### Cline
+
+```json
+{
+  "mcpServers": {
+    "workspace": {
+      "command": "npx",
+      "args": ["-y", "ssh-agent-workspace"]
+    }
+  }
+}
+```
+
+#### Qoder
+
+```bash
+qodercli mcp add workspace -- npx -y ssh-agent-workspace
 ```
 
+#### Using npx
+
+All examples above use `npx` which auto-downloads the latest version. No global install needed.
+
+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.
 
 ---
@@ -263,25 +423,6 @@ No restart needed. Changes apply immediately.
 | `MCP_SSH_DENYLIST_COMMANDS` | `(none)` | Global command blocklist |
 | `MCP_SSH_RESTORE_SESSIONS` | `true` | Auto-restore workspaces on startup |
 
-### SSH Config
-
-Hosts must be defined in `~/.ssh/config`:
-
-```
-Host prod
-  HostName 10.0.0.5
-  User deploy
-  IdentityFile ~/.ssh/id_ed25519
-
-Host internal
-  HostName 172.16.0.50
-  User admin
-  ProxyJump bastion
-
-Host bastion
-  HostName jump.example.com
-  User jumpuser
-```
 ---
 
 ## Project Structure

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ssh-agent-workspace",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "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",