@tmhs/homelab-mcp 0.20.2 → 0.21.0

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.
package/README.md CHANGED
@@ -81,6 +81,7 @@ Set environment variables:
81
81
  | `HOMELAB_COMPOSE_DIR` | `/opt/homelab/docker` | Compose project directory on Pi |
82
82
  | `HOMELAB_COMPOSE_FILES` | (discovered) | Comma-separated compose files (in order) used when no `stacks` are passed. If unset, `compose.base.yml` and every `compose.*.yml` in the compose dir are used, falling back to `compose.yaml` / `docker-compose.yml` |
83
83
  | `HOMELAB_BACKUP_REPO` | `/mnt/backup/restic` | Restic backup repo path on Pi |
84
+ | `HOMELAB_BACKUP_SCRIPT` | `/opt/backup/backup.sh` | Script `homelab_backupRun` runs with sudo (absolute path) |
84
85
  | `HOMELAB_RESTIC_ENV_FILE` | `/etc/restic-env` | Env file on the node, sourced as root (when it exists) before every restic call, for `RESTIC_PASSWORD` and backend credentials. `none` disables it |
85
86
  | `HOMELAB_RESTIC_PASSWORD_FILE` | (empty) | Restic password file on the node, passed as `--password-file` |
86
87
  | `HOMELAB_GRAFANA_TOKEN` | (empty) | Grafana API token (preferred auth method) |
package/dist/index.js CHANGED
@@ -58,7 +58,7 @@ import { registerResources } from "./resources.js";
58
58
  import { registerPrompts } from "./prompts.js";
59
59
  const server = new McpServer({
60
60
  name: "homelab-mcp",
61
- version: "0.20.2",
61
+ version: "0.21.0",
62
62
  });
63
63
  registerPiStatus(server);
64
64
  registerPiReboot(server);
@@ -1,3 +1,7 @@
1
1
  import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
2
+ export declare const DEFAULT_BACKUP_SCRIPT = "/opt/backup/backup.sh";
3
+ /** Backup script for a node (HOMELAB_BACKUP_SCRIPT, per-node overridable). */
4
+ export declare function backupScript(node?: string): string;
5
+ export declare function backupCommand(node?: string): string;
2
6
  export declare function register(server: McpServer): void;
3
7
  //# sourceMappingURL=backupRun.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"backupRun.d.ts","sourceRoot":"","sources":["../../src/tools/backupRun.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAsBzE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAmBhD"}
1
+ {"version":3,"file":"backupRun.d.ts","sourceRoot":"","sources":["../../src/tools/backupRun.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAUzE,eAAO,MAAM,qBAAqB,0BAA0B,CAAC;AAG7D,8EAA8E;AAC9E,wBAAgB,YAAY,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAQlD;AAKD,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CASnD;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAmBhD"}
@@ -1,26 +1,38 @@
1
- import { execSSH, errorResponse, TIMEOUTS } from "../utils/ssh-api.js";
1
+ import { execSSH, errorResponse, nodeSetting, TIMEOUTS } from "../utils/ssh-api.js";
2
2
  import { nodeParam } from "../utils/node-param.js";
3
3
  import { confirmParam, confirmCancelled } from "../utils/confirm-param.js";
4
4
  const inputSchema = {
5
5
  ...nodeParam,
6
6
  ...confirmParam,
7
7
  };
8
- const BACKUP_SCRIPT = "/opt/backup/backup.sh";
8
+ export const DEFAULT_BACKUP_SCRIPT = "/opt/backup/backup.sh";
9
+ const SCRIPT_RE = /^\/[A-Za-z0-9._\/-]+$/;
10
+ /** Backup script for a node (HOMELAB_BACKUP_SCRIPT, per-node overridable). */
11
+ export function backupScript(node) {
12
+ const script = nodeSetting(node, "HOMELAB_BACKUP_SCRIPT") || DEFAULT_BACKUP_SCRIPT;
13
+ if (!SCRIPT_RE.test(script)) {
14
+ throw new Error("HOMELAB_BACKUP_SCRIPT must be an absolute path on the node (letters, digits, '.', '_', '-', '/').");
15
+ }
16
+ return script;
17
+ }
9
18
  // Check for the script separately so "not found" is only reported when it is
10
19
  // actually missing. A failing backup exits non-zero and surfaces as an error
11
- // with the tail of its output.
12
- const BACKUP_COMMAND = `if ! sudo test -x ${BACKUP_SCRIPT}; then ` +
13
- `echo 'Backup script not found or not executable at ${BACKUP_SCRIPT}' >&2; exit 127; fi; ` +
14
- `out=$(sudo ${BACKUP_SCRIPT} 2>&1); rc=$?; ` +
15
- `if [ "$rc" -ne 0 ]; then printf '%s\\n' "$out" | tail -40 >&2; exit "$rc"; fi; ` +
16
- `printf '%s\\n' "$out"`;
20
+ // with the tail of its output. The path is validated, so quoting is enough.
21
+ export function backupCommand(node) {
22
+ const script = backupScript(node);
23
+ return (`if ! sudo test -x '${script}'; then ` +
24
+ `echo 'Backup script not found or not executable at ${script}. Set HOMELAB_BACKUP_SCRIPT.' >&2; exit 127; fi; ` +
25
+ `out=$(sudo '${script}' 2>&1); rc=$?; ` +
26
+ `if [ "$rc" -ne 0 ]; then printf '%s\\n' "$out" | tail -40 >&2; exit "$rc"; fi; ` +
27
+ `printf '%s\\n' "$out"`);
28
+ }
17
29
  export function register(server) {
18
- server.tool("homelab_backupRun", "Trigger a restic backup on the Pi", inputSchema, async (args) => {
30
+ server.tool("homelab_backupRun", "Trigger a restic backup on the Pi by running its backup script (HOMELAB_BACKUP_SCRIPT)", inputSchema, async (args) => {
19
31
  if (!args.confirm) {
20
- return confirmCancelled("Backup", { node: args.node, commands: () => [BACKUP_COMMAND] });
32
+ return confirmCancelled("Backup", { node: args.node, commands: () => [backupCommand(args.node)] });
21
33
  }
22
34
  try {
23
- const output = await execSSH(BACKUP_COMMAND, args.node, { timeoutMs: TIMEOUTS.backup });
35
+ const output = await execSSH(backupCommand(args.node), args.node, { timeoutMs: TIMEOUTS.backup });
24
36
  return { content: [{ type: "text", text: output }] };
25
37
  }
26
38
  catch (error) {
@@ -1 +1 @@
1
- {"version":3,"file":"backupRun.js","sourceRoot":"","sources":["../../src/tools/backupRun.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE3E,MAAM,WAAW,GAAG;IAClB,GAAG,SAAS;IACZ,GAAG,YAAY;CAChB,CAAC;AAEF,MAAM,aAAa,GAAG,uBAAuB,CAAC;AAE9C,6EAA6E;AAC7E,6EAA6E;AAC7E,+BAA+B;AAC/B,MAAM,cAAc,GAClB,qBAAqB,aAAa,SAAS;IAC3C,sDAAsD,aAAa,uBAAuB;IAC1F,cAAc,aAAa,iBAAiB;IAC5C,iFAAiF;IACjF,uBAAuB,CAAC;AAE1B,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,mBAAmB,EACnB,mCAAmC,EACnC,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAExF,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"backupRun.js","sourceRoot":"","sources":["../../src/tools/backupRun.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAE3E,MAAM,WAAW,GAAG;IAClB,GAAG,SAAS;IACZ,GAAG,YAAY;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAC7D,MAAM,SAAS,GAAG,uBAAuB,CAAC;AAE1C,8EAA8E;AAC9E,MAAM,UAAU,YAAY,CAAC,IAAa;IACxC,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,uBAAuB,CAAC,IAAI,qBAAqB,CAAC;IACnF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CACb,mGAAmG,CACpG,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,6EAA6E;AAC7E,6EAA6E;AAC7E,4EAA4E;AAC5E,MAAM,UAAU,aAAa,CAAC,IAAa;IACzC,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IAClC,OAAO,CACL,sBAAsB,MAAM,UAAU;QACtC,sDAAsD,MAAM,mDAAmD;QAC/G,eAAe,MAAM,kBAAkB;QACvC,iFAAiF;QACjF,uBAAuB,CACxB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,mBAAmB,EACnB,wFAAwF,EACxF,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,gBAAgB,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;QACrG,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAElG,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;QAChE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tmhs/homelab-mcp",
3
- "version": "0.20.2",
3
+ "version": "0.21.0",
4
4
  "description": "MCP server for home lab operations via SSH - 53 tools for system status, Docker Compose management, service health, monitoring, DNS, reverse proxy, networking, backups, disaster recovery, security auditing, logs, notifications, OS management, certificates, multi-node, diagnostics, and administration on a Raspberry Pi.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -20,6 +20,7 @@
20
20
  "dev": "tsx watch src/index.ts",
21
21
  "start": "node dist/index.js",
22
22
  "test": "vitest run",
23
+ "typecheck": "tsc -p tsconfig.test.json",
23
24
  "test:watch": "vitest",
24
25
  "prepublishOnly": "npm run build"
25
26
  },