ssh-agent-workspace 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +50 -24
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -123,9 +123,8 @@ Your agent now has a persistent workspace on `prod`.
123
123
 
124
124
  ### Add to Your MCP Client
125
125
 
126
- Pick your client:
127
-
128
- #### OpenCode
126
+ <details>
127
+ <summary><b>OpenCode</b></summary>
129
128
 
130
129
  Add to `~/.config/opencode/opencode.json`:
131
130
 
@@ -146,8 +145,10 @@ Or via CLI:
146
145
  ```bash
147
146
  opencode mcp add workspace -- npx -y ssh-agent-workspace
148
147
  ```
148
+ </details>
149
149
 
150
- #### Claude Code
150
+ <details>
151
+ <summary><b>Claude Code</b></summary>
151
152
 
152
153
  ```bash
153
154
  claude mcp add workspace -- npx -y ssh-agent-workspace
@@ -177,9 +178,11 @@ Or add to `~/.config/claude-code/claude_code_config.json` or project `.mcp.json`
177
178
  }
178
179
  ```
179
180
 
180
- **Tip:** The `autoApprove` block lets the agent use those tools without asking permission each time. Add or remove tools based on your comfort level.
181
+ > **Tip:** The `autoApprove` block lets the agent use those tools without asking permission each time. Add or remove tools based on your comfort level.
182
+ </details>
181
183
 
182
- #### Cursor
184
+ <details>
185
+ <summary><b>Cursor</b></summary>
183
186
 
184
187
  Go to `Cursor Settings` → `MCP` → `New MCP Server`. Use this config:
185
188
 
@@ -193,8 +196,10 @@ Go to `Cursor Settings` → `MCP` → `New MCP Server`. Use this config:
193
196
  }
194
197
  }
195
198
  ```
199
+ </details>
196
200
 
197
- #### Codex (OpenAI)
201
+ <details>
202
+ <summary><b>Codex (OpenAI)</b></summary>
198
203
 
199
204
  ```bash
200
205
  codex mcp add workspace -- npx -y ssh-agent-workspace
@@ -207,8 +212,10 @@ Or add to `~/.codex/config.toml`:
207
212
  command = "npx"
208
213
  args = ["-y", "ssh-agent-workspace"]
209
214
  ```
215
+ </details>
210
216
 
211
- #### Windsurf
217
+ <details>
218
+ <summary><b>Windsurf</b></summary>
212
219
 
213
220
  Add to `~/.codeium/windsurf/mcp_config.json`:
214
221
 
@@ -222,8 +229,10 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
222
229
  }
223
230
  }
224
231
  ```
232
+ </details>
225
233
 
226
- #### Copilot / VS Code
234
+ <details>
235
+ <summary><b>Copilot / VS Code</b></summary>
227
236
 
228
237
  ```json
229
238
  {
@@ -235,14 +244,18 @@ Add to `~/.codeium/windsurf/mcp_config.json`:
235
244
  }
236
245
  }
237
246
  ```
247
+ </details>
238
248
 
239
- #### Gemini CLI
249
+ <details>
250
+ <summary><b>Gemini CLI</b></summary>
240
251
 
241
252
  ```bash
242
253
  gemini mcp add workspace npx -y ssh-agent-workspace
243
254
  ```
255
+ </details>
244
256
 
245
- #### Cline
257
+ <details>
258
+ <summary><b>Cline</b></summary>
246
259
 
247
260
  ```json
248
261
  {
@@ -254,18 +267,17 @@ gemini mcp add workspace npx -y ssh-agent-workspace
254
267
  }
255
268
  }
256
269
  ```
270
+ </details>
257
271
 
258
- #### Qoder
272
+ <details>
273
+ <summary><b>Qoder</b></summary>
259
274
 
260
275
  ```bash
261
276
  qodercli mcp add workspace -- npx -y ssh-agent-workspace
262
277
  ```
278
+ </details>
263
279
 
264
- #### Using npx
265
-
266
- All examples above use `npx` which auto-downloads the latest version. No global install needed.
267
-
268
- If you installed globally (`npm install -g ssh-agent-workspace`), replace `"npx"` / `"-y"` / `"ssh-agent-workspace"` with `"ssh-agent-workspace"` as the command directly.
280
+ > **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.
269
281
 
270
282
  Your agent now has a persistent workspace on `prod`. Running `cd /var/www` once means the agent stays there for every subsequent command.
271
283
 
@@ -322,7 +334,8 @@ No restart needed. Changes apply immediately.
322
334
 
323
335
  ## Tools (25)
324
336
 
325
- ### Workspace (9)
337
+ <details>
338
+ <summary><b>Workspace (9 tools)</b></summary>
326
339
 
327
340
  | Tool | Description |
328
341
  |---|---|
@@ -335,45 +348,58 @@ No restart needed. Changes apply immediately.
335
348
  | `disconnect` | Close session. Optionally kill tmux or keep alive |
336
349
  | `list_hosts` | List `~/.ssh/config` aliases |
337
350
  | `list_sessions` | List active workspaces |
351
+ </details>
338
352
 
339
- ### File Transfer (3)
353
+ <details>
354
+ <summary><b>File Transfer (3 tools)</b></summary>
340
355
 
341
356
  | Tool | Description |
342
357
  |---|---|
343
358
  | `sftp_upload` | Upload file to remote |
344
359
  | `sftp_download` | Download file from remote |
345
360
  | `sftp_list` | List remote directory |
361
+ </details>
346
362
 
347
- ### Monitoring (3)
363
+ <details>
364
+ <summary><b>Monitoring (3 tools)</b></summary>
348
365
 
349
366
  | Tool | Description |
350
367
  |---|---|
351
368
  | `connection_status` | SSH liveness + tmux existence |
352
369
  | `health_check` | CPU / RAM / Disk / Load / Uptime |
353
370
  | `tail_log` | Log tail with optional follow |
371
+ </details>
354
372
 
355
- ### DevOps (4)
373
+ <details>
374
+ <summary><b>DevOps (6 tools)</b></summary>
356
375
 
357
376
  | Tool | Description |
358
377
  |---|---|
359
378
  | `deploy` | Upload → backup → chmod → chown → restart |
360
379
  | `backup` | tar.gz archive → download → cleanup |
361
380
  | `sync` | Rsync-lite via SFTP (bidirectional, dry-run) |
362
- | `ssh_tunnel_open` / `ssh_tunnel_list` / `ssh_tunnel_close` | Port forwarding + SOCKS5 |
381
+ | `ssh_tunnel_open` | Local port forward or SOCKS5 proxy |
382
+ | `ssh_tunnel_list` | List active tunnels |
383
+ | `ssh_tunnel_close` | Close tunnel, free port |
384
+ </details>
363
385
 
364
- ### Cluster & Queries (2)
386
+ <details>
387
+ <summary><b>Cluster & Queries (2 tools)</b></summary>
365
388
 
366
389
  | Tool | Description |
367
390
  |---|---|
368
391
  | `group_exec` | Run command across multiple workspaces (parallel/sequential) |
369
392
  | `db_query` | Read-only MySQL / PostgreSQL / MongoDB via SSH |
393
+ </details>
370
394
 
371
- ### Runtime Config (2)
395
+ <details>
396
+ <summary><b>Runtime Config (2 tools)</b></summary>
372
397
 
373
398
  | Tool | Description |
374
399
  |---|---|
375
400
  | `tools_config` | Enable/disable tools at runtime |
376
401
  | `host_security` | Per-host read-only, command allow/denylist |
402
+ </details>
377
403
 
378
404
  **Full reference:** [`docs/TOOLS.md`](docs/TOOLS.md) | **Security:** [`docs/SECURITY.md`](docs/SECURITY.md)
379
405
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ssh-agent-workspace",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "Persistent SSH workspaces for AI agents. Stateful tmux-backed sessions that survive reconnects, restarts, and network drops — with runtime security and tool configuration.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",