@tmhs/homelab-mcp 0.2.0 → 0.2.1
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 +14 -1
- package/dist/index.js +1 -1
- package/dist/tools/alertList.d.ts.map +1 -1
- package/dist/tools/alertList.js +15 -1
- package/dist/tools/alertList.js.map +1 -1
- package/dist/tools/grafanaSnapshot.d.ts.map +1 -1
- package/dist/tools/grafanaSnapshot.js +33 -1
- package/dist/tools/grafanaSnapshot.js.map +1 -1
- package/dist/tools/prometheusQuery.d.ts.map +1 -1
- package/dist/tools/prometheusQuery.js +15 -1
- package/dist/tools/prometheusQuery.js.map +1 -1
- package/dist/tools/speedtestResults.d.ts.map +1 -1
- package/dist/tools/speedtestResults.js +15 -1
- package/dist/tools/speedtestResults.js.map +1 -1
- package/dist/tools/uptimeKumaStatus.d.ts.map +1 -1
- package/dist/tools/uptimeKumaStatus.js +15 -1
- package/dist/tools/uptimeKumaStatus.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Home Lab MCP Server
|
|
2
2
|
|
|
3
|
-
MCP (Model Context Protocol) server for home lab operations. Connects to a Raspberry Pi via SSH and provides
|
|
3
|
+
MCP (Model Context Protocol) server for home lab operations. Connects to a Raspberry Pi via SSH and provides 20 tools for system management, Docker Compose stacks, service monitoring, networking, and backups.
|
|
4
4
|
|
|
5
5
|
## Tools
|
|
6
6
|
|
|
@@ -20,6 +20,11 @@ MCP (Model Context Protocol) server for home lab operations. Connects to a Raspb
|
|
|
20
20
|
| Network | `homelab_networkInfo` | IP addresses, DNS, Tailscale status |
|
|
21
21
|
| Backup | `homelab_backupStatus` | Check latest restic snapshots |
|
|
22
22
|
| Backup | `homelab_backupRun` | Trigger restic backup |
|
|
23
|
+
| Monitoring | `homelab_prometheusQuery` | Run PromQL queries against Prometheus |
|
|
24
|
+
| Monitoring | `homelab_grafanaSnapshot` | Export Grafana dashboard config by UID |
|
|
25
|
+
| Monitoring | `homelab_uptimeKumaStatus` | Get Uptime Kuma monitor statuses |
|
|
26
|
+
| Monitoring | `homelab_alertList` | List Alertmanager alerts by state |
|
|
27
|
+
| Monitoring | `homelab_speedtestResults` | Get recent Speedtest Tracker results |
|
|
23
28
|
| SSH | `homelab_sshTest` | Test SSH connectivity |
|
|
24
29
|
|
|
25
30
|
## Setup
|
|
@@ -41,6 +46,14 @@ Set environment variables:
|
|
|
41
46
|
| `HOMELAB_PI_KEY_PATH` | (empty) | Path to SSH private key |
|
|
42
47
|
| `HOMELAB_COMPOSE_DIR` | `/opt/homelab/docker` | Compose project directory on Pi |
|
|
43
48
|
| `HOMELAB_BACKUP_REPO` | `/mnt/backup/restic` | Restic backup repo path on Pi |
|
|
49
|
+
| `HOMELAB_GRAFANA_TOKEN` | (empty) | Grafana API token (preferred auth method) |
|
|
50
|
+
| `HOMELAB_GRAFANA_USER` | `admin` | Grafana basic auth username |
|
|
51
|
+
| `HOMELAB_GRAFANA_PASSWORD` | (empty) | Grafana basic auth password (falls back to admin/admin) |
|
|
52
|
+
| `HOMELAB_PROMETHEUS_PORT` | `9090` | Prometheus port override |
|
|
53
|
+
| `HOMELAB_GRAFANA_PORT` | `3000` | Grafana port override |
|
|
54
|
+
| `HOMELAB_ALERTMANAGER_PORT` | `9093` | Alertmanager port override |
|
|
55
|
+
| `HOMELAB_UPTIME_KUMA_PORT` | `3001` | Uptime Kuma port override |
|
|
56
|
+
| `HOMELAB_SPEEDTEST_PORT` | `8765` | Speedtest Tracker port override |
|
|
44
57
|
|
|
45
58
|
## Usage with Cursor
|
|
46
59
|
|
package/dist/index.js
CHANGED
|
@@ -23,7 +23,7 @@ import { register as registerAlertList } from "./tools/alertList.js";
|
|
|
23
23
|
import { register as registerSpeedtestResults } from "./tools/speedtestResults.js";
|
|
24
24
|
const server = new McpServer({
|
|
25
25
|
name: "homelab-mcp",
|
|
26
|
-
version: "0.2.
|
|
26
|
+
version: "0.2.1",
|
|
27
27
|
});
|
|
28
28
|
registerPiStatus(server);
|
|
29
29
|
registerPiReboot(server);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alertList.d.ts","sourceRoot":"","sources":["../../src/tools/alertList.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"alertList.d.ts","sourceRoot":"","sources":["../../src/tools/alertList.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAmBzE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CA6BhD"}
|
package/dist/tools/alertList.js
CHANGED
|
@@ -1,19 +1,33 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
import { execSSH, errorResponse } from "../utils/ssh-api.js";
|
|
3
|
+
import { CommandFailedError } from "../utils/errors.js";
|
|
4
|
+
const DEFAULT_PORT = 9093;
|
|
5
|
+
const SERVICE_NAME = "Alertmanager";
|
|
3
6
|
const inputSchema = {
|
|
4
7
|
state: z
|
|
5
8
|
.enum(["active", "suppressed", "unprocessed"])
|
|
6
9
|
.optional()
|
|
7
10
|
.describe("Filter alerts by state. Returns all states if omitted"),
|
|
8
11
|
};
|
|
12
|
+
function getPort() {
|
|
13
|
+
const override = process.env.HOMELAB_ALERTMANAGER_PORT;
|
|
14
|
+
return override ? parseInt(override, 10) : DEFAULT_PORT;
|
|
15
|
+
}
|
|
9
16
|
export function register(server) {
|
|
10
17
|
server.tool("homelab_alertList", "List alerts from Alertmanager, optionally filtered by state", inputSchema, async (args) => {
|
|
18
|
+
const port = getPort();
|
|
11
19
|
try {
|
|
12
20
|
const stateParam = args.state ? `?state=${args.state}` : "";
|
|
13
|
-
const output = await execSSH(`curl -sf 'http://localhost
|
|
21
|
+
const output = await execSSH(`curl -sf 'http://localhost:${port}/api/v2/alerts${stateParam}'`);
|
|
14
22
|
return { content: [{ type: "text", text: output }] };
|
|
15
23
|
}
|
|
16
24
|
catch (error) {
|
|
25
|
+
if (error instanceof CommandFailedError) {
|
|
26
|
+
if (error.exitCode === 7) {
|
|
27
|
+
return errorResponse(new Error(`Could not connect to ${SERVICE_NAME} on port ${port}. Is it running? ` +
|
|
28
|
+
`Set HOMELAB_ALERTMANAGER_PORT if using a non-default port.`));
|
|
29
|
+
}
|
|
30
|
+
}
|
|
17
31
|
return errorResponse(error);
|
|
18
32
|
}
|
|
19
33
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alertList.js","sourceRoot":"","sources":["../../src/tools/alertList.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"alertList.js","sourceRoot":"","sources":["../../src/tools/alertList.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,YAAY,GAAG,cAAc,CAAC;AAEpC,MAAM,WAAW,GAAG;IAClB,KAAK,EAAE,CAAC;SACL,IAAI,CAAC,CAAC,QAAQ,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;SAC7C,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC;AAEF,SAAS,OAAO;IACd,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC;IACvD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,mBAAmB,EACnB,6DAA6D,EAC7D,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5D,MAAM,MAAM,GAAG,MAAM,OAAO,CAC1B,8BAA8B,IAAI,iBAAiB,UAAU,GAAG,CACjE,CAAC;YAEF,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,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;gBACxC,IAAI,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,aAAa,CAClB,IAAI,KAAK,CACP,wBAAwB,YAAY,YAAY,IAAI,mBAAmB;wBACrE,4DAA4D,CAC/D,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"grafanaSnapshot.d.ts","sourceRoot":"","sources":["../../src/tools/grafanaSnapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"grafanaSnapshot.d.ts","sourceRoot":"","sources":["../../src/tools/grafanaSnapshot.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AA6BzE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAsChD"}
|
|
@@ -1,15 +1,47 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
import { execSSH, errorResponse } from "../utils/ssh-api.js";
|
|
3
|
+
import { CommandFailedError } from "../utils/errors.js";
|
|
4
|
+
const DEFAULT_PORT = 3000;
|
|
5
|
+
const SERVICE_NAME = "Grafana";
|
|
3
6
|
const inputSchema = {
|
|
4
7
|
dashboard: z.string().min(1).describe("Dashboard UID to export"),
|
|
5
8
|
};
|
|
9
|
+
function getPort() {
|
|
10
|
+
const override = process.env.HOMELAB_GRAFANA_PORT;
|
|
11
|
+
return override ? parseInt(override, 10) : DEFAULT_PORT;
|
|
12
|
+
}
|
|
13
|
+
function buildAuthHeader() {
|
|
14
|
+
const token = process.env.HOMELAB_GRAFANA_TOKEN;
|
|
15
|
+
if (token) {
|
|
16
|
+
return `-H 'Authorization: Bearer ${token}'`;
|
|
17
|
+
}
|
|
18
|
+
const user = process.env.HOMELAB_GRAFANA_USER || "admin";
|
|
19
|
+
const password = process.env.HOMELAB_GRAFANA_PASSWORD;
|
|
20
|
+
if (password) {
|
|
21
|
+
return `-u '${user}:${password}'`;
|
|
22
|
+
}
|
|
23
|
+
return `-u 'admin:admin'`;
|
|
24
|
+
}
|
|
6
25
|
export function register(server) {
|
|
7
26
|
server.tool("homelab_grafanaSnapshot", "Export a Grafana dashboard configuration by UID", inputSchema, async (args) => {
|
|
27
|
+
const port = getPort();
|
|
8
28
|
try {
|
|
9
|
-
const
|
|
29
|
+
const auth = buildAuthHeader();
|
|
30
|
+
const output = await execSSH(`curl -sf ${auth} 'http://localhost:${port}/api/dashboards/uid/${args.dashboard}'`);
|
|
10
31
|
return { content: [{ type: "text", text: output }] };
|
|
11
32
|
}
|
|
12
33
|
catch (error) {
|
|
34
|
+
if (error instanceof CommandFailedError) {
|
|
35
|
+
if (error.exitCode === 7) {
|
|
36
|
+
return errorResponse(new Error(`Could not reach ${SERVICE_NAME} API on port ${port}. Is it running? ` +
|
|
37
|
+
`Set HOMELAB_GRAFANA_PORT if using a non-default port.`));
|
|
38
|
+
}
|
|
39
|
+
if (error.exitCode === 22) {
|
|
40
|
+
return errorResponse(new Error(`${SERVICE_NAME} returned an HTTP error. Check authentication -- ` +
|
|
41
|
+
`set HOMELAB_GRAFANA_TOKEN (API key) or HOMELAB_GRAFANA_USER/HOMELAB_GRAFANA_PASSWORD. ` +
|
|
42
|
+
`Also verify the dashboard UID "${args.dashboard}" exists.`));
|
|
43
|
+
}
|
|
44
|
+
}
|
|
13
45
|
return errorResponse(error);
|
|
14
46
|
}
|
|
15
47
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"grafanaSnapshot.js","sourceRoot":"","sources":["../../src/tools/grafanaSnapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"grafanaSnapshot.js","sourceRoot":"","sources":["../../src/tools/grafanaSnapshot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,YAAY,GAAG,SAAS,CAAC;AAE/B,MAAM,WAAW,GAAG;IAClB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,yBAAyB,CAAC;CACjE,CAAC;AAEF,SAAS,OAAO;IACd,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC;IAClD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAC1D,CAAC;AAED,SAAS,eAAe;IACtB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IAChD,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,6BAA6B,KAAK,GAAG,CAAC;IAC/C,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,oBAAoB,IAAI,OAAO,CAAC;IACzD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;IACtD,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,OAAO,IAAI,IAAI,QAAQ,GAAG,CAAC;IACpC,CAAC;IACD,OAAO,kBAAkB,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,yBAAyB,EACzB,iDAAiD,EACjD,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,MAAM,OAAO,CAC1B,YAAY,IAAI,sBAAsB,IAAI,uBAAuB,IAAI,CAAC,SAAS,GAAG,CACnF,CAAC;YAEF,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,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;gBACxC,IAAI,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,aAAa,CAClB,IAAI,KAAK,CACP,mBAAmB,YAAY,gBAAgB,IAAI,mBAAmB;wBACpE,uDAAuD,CAC1D,CACF,CAAC;gBACJ,CAAC;gBACD,IAAI,KAAK,CAAC,QAAQ,KAAK,EAAE,EAAE,CAAC;oBAC1B,OAAO,aAAa,CAClB,IAAI,KAAK,CACP,GAAG,YAAY,mDAAmD;wBAChE,wFAAwF;wBACxF,kCAAkC,IAAI,CAAC,SAAS,WAAW,CAC9D,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prometheusQuery.d.ts","sourceRoot":"","sources":["../../src/tools/prometheusQuery.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"prometheusQuery.d.ts","sourceRoot":"","sources":["../../src/tools/prometheusQuery.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAoBzE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CA8BhD"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
import { execSSH, errorResponse } from "../utils/ssh-api.js";
|
|
3
|
+
import { CommandFailedError } from "../utils/errors.js";
|
|
4
|
+
const DEFAULT_PORT = 9090;
|
|
5
|
+
const SERVICE_NAME = "Prometheus";
|
|
3
6
|
const inputSchema = {
|
|
4
7
|
query: z.string().min(1).describe("PromQL expression to evaluate"),
|
|
5
8
|
time: z
|
|
@@ -7,15 +10,26 @@ const inputSchema = {
|
|
|
7
10
|
.optional()
|
|
8
11
|
.describe("Evaluation timestamp (RFC3339 or Unix). Defaults to current time"),
|
|
9
12
|
};
|
|
13
|
+
function getPort() {
|
|
14
|
+
const override = process.env.HOMELAB_PROMETHEUS_PORT;
|
|
15
|
+
return override ? parseInt(override, 10) : DEFAULT_PORT;
|
|
16
|
+
}
|
|
10
17
|
export function register(server) {
|
|
11
18
|
server.tool("homelab_prometheusQuery", "Run a PromQL query against Prometheus and return the result", inputSchema, async (args) => {
|
|
19
|
+
const port = getPort();
|
|
12
20
|
try {
|
|
13
21
|
const encoded = encodeURIComponent(args.query);
|
|
14
22
|
const timeParam = args.time ? `&time=${encodeURIComponent(args.time)}` : "";
|
|
15
|
-
const output = await execSSH(`curl -sf 'http://localhost
|
|
23
|
+
const output = await execSSH(`curl -sf 'http://localhost:${port}/api/v1/query?query=${encoded}${timeParam}'`);
|
|
16
24
|
return { content: [{ type: "text", text: output }] };
|
|
17
25
|
}
|
|
18
26
|
catch (error) {
|
|
27
|
+
if (error instanceof CommandFailedError) {
|
|
28
|
+
if (error.exitCode === 7) {
|
|
29
|
+
return errorResponse(new Error(`Could not reach ${SERVICE_NAME} on port ${port}. Is it running? ` +
|
|
30
|
+
`Set HOMELAB_PROMETHEUS_PORT if using a non-default port.`));
|
|
31
|
+
}
|
|
32
|
+
}
|
|
19
33
|
return errorResponse(error);
|
|
20
34
|
}
|
|
21
35
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"prometheusQuery.js","sourceRoot":"","sources":["../../src/tools/prometheusQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"prometheusQuery.js","sourceRoot":"","sources":["../../src/tools/prometheusQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,YAAY,GAAG,YAAY,CAAC;AAElC,MAAM,WAAW,GAAG;IAClB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAClE,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,kEAAkE,CAAC;CAChF,CAAC;AAEF,SAAS,OAAO;IACd,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC;IACrD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,yBAAyB,EACzB,6DAA6D,EAC7D,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5E,MAAM,MAAM,GAAG,MAAM,OAAO,CAC1B,8BAA8B,IAAI,uBAAuB,OAAO,GAAG,SAAS,GAAG,CAChF,CAAC;YAEF,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,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;gBACxC,IAAI,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,aAAa,CAClB,IAAI,KAAK,CACP,mBAAmB,YAAY,YAAY,IAAI,mBAAmB;wBAChE,0DAA0D,CAC7D,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"speedtestResults.d.ts","sourceRoot":"","sources":["../../src/tools/speedtestResults.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"speedtestResults.d.ts","sourceRoot":"","sources":["../../src/tools/speedtestResults.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAsBzE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CA4BhD"}
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
import { execSSH, errorResponse } from "../utils/ssh-api.js";
|
|
3
|
+
import { CommandFailedError } from "../utils/errors.js";
|
|
4
|
+
const DEFAULT_PORT = 8765;
|
|
5
|
+
const SERVICE_NAME = "Speedtest Tracker";
|
|
3
6
|
const inputSchema = {
|
|
4
7
|
count: z
|
|
5
8
|
.number()
|
|
@@ -9,13 +12,24 @@ const inputSchema = {
|
|
|
9
12
|
.default(5)
|
|
10
13
|
.describe("Number of recent speedtest results to return"),
|
|
11
14
|
};
|
|
15
|
+
function getPort() {
|
|
16
|
+
const override = process.env.HOMELAB_SPEEDTEST_PORT;
|
|
17
|
+
return override ? parseInt(override, 10) : DEFAULT_PORT;
|
|
18
|
+
}
|
|
12
19
|
export function register(server) {
|
|
13
20
|
server.tool("homelab_speedtestResults", "Get recent speedtest results from Speedtest Tracker", inputSchema, async (args) => {
|
|
21
|
+
const port = getPort();
|
|
14
22
|
try {
|
|
15
|
-
const output = await execSSH(`curl -sf 'http://localhost
|
|
23
|
+
const output = await execSSH(`curl -sf 'http://localhost:${port}/api/speedtest/latest?limit=${args.count}'`);
|
|
16
24
|
return { content: [{ type: "text", text: output }] };
|
|
17
25
|
}
|
|
18
26
|
catch (error) {
|
|
27
|
+
if (error instanceof CommandFailedError) {
|
|
28
|
+
if (error.exitCode === 7) {
|
|
29
|
+
return errorResponse(new Error(`Could not connect to ${SERVICE_NAME} on port ${port}. Is it running? ` +
|
|
30
|
+
`Set HOMELAB_SPEEDTEST_PORT if using a non-default port.`));
|
|
31
|
+
}
|
|
32
|
+
}
|
|
19
33
|
return errorResponse(error);
|
|
20
34
|
}
|
|
21
35
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"speedtestResults.js","sourceRoot":"","sources":["../../src/tools/speedtestResults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"speedtestResults.js","sourceRoot":"","sources":["../../src/tools/speedtestResults.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,YAAY,GAAG,mBAAmB,CAAC;AAEzC,MAAM,WAAW,GAAG;IAClB,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,EAAE;SACV,OAAO,CAAC,CAAC,CAAC;SACV,QAAQ,CAAC,8CAA8C,CAAC;CAC5D,CAAC;AAEF,SAAS,OAAO;IACd,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC;IACpD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,0BAA0B,EAC1B,qDAAqD,EACrD,WAAW,EACX,KAAK,EAAE,IAAI,EAAE,EAAE;QACb,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAC1B,8BAA8B,IAAI,+BAA+B,IAAI,CAAC,KAAK,GAAG,CAC/E,CAAC;YAEF,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,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;gBACxC,IAAI,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,aAAa,CAClB,IAAI,KAAK,CACP,wBAAwB,YAAY,YAAY,IAAI,mBAAmB;wBACrE,yDAAyD,CAC5D,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC,CACF,CAAC;AACJ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"uptimeKumaStatus.d.ts","sourceRoot":"","sources":["../../src/tools/uptimeKumaStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;
|
|
1
|
+
{"version":3,"file":"uptimeKumaStatus.d.ts","sourceRoot":"","sources":["../../src/tools/uptimeKumaStatus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAYzE,wBAAgB,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CA4BhD"}
|
|
@@ -1,11 +1,25 @@
|
|
|
1
1
|
import { execSSH, errorResponse } from "../utils/ssh-api.js";
|
|
2
|
+
import { CommandFailedError } from "../utils/errors.js";
|
|
3
|
+
const DEFAULT_PORT = 3001;
|
|
4
|
+
const SERVICE_NAME = "Uptime Kuma";
|
|
5
|
+
function getPort() {
|
|
6
|
+
const override = process.env.HOMELAB_UPTIME_KUMA_PORT;
|
|
7
|
+
return override ? parseInt(override, 10) : DEFAULT_PORT;
|
|
8
|
+
}
|
|
2
9
|
export function register(server) {
|
|
3
10
|
server.tool("homelab_uptimeKumaStatus", "Get the status of all Uptime Kuma monitors", {}, async () => {
|
|
11
|
+
const port = getPort();
|
|
4
12
|
try {
|
|
5
|
-
const output = await execSSH(`curl -sf 'http://localhost
|
|
13
|
+
const output = await execSSH(`curl -sf 'http://localhost:${port}/api/status-page/heartbeat/default'`);
|
|
6
14
|
return { content: [{ type: "text", text: output }] };
|
|
7
15
|
}
|
|
8
16
|
catch (error) {
|
|
17
|
+
if (error instanceof CommandFailedError) {
|
|
18
|
+
if (error.exitCode === 7) {
|
|
19
|
+
return errorResponse(new Error(`Could not connect to ${SERVICE_NAME} on port ${port}. Is it running? ` +
|
|
20
|
+
`Set HOMELAB_UPTIME_KUMA_PORT if using a non-default port.`));
|
|
21
|
+
}
|
|
22
|
+
}
|
|
9
23
|
return errorResponse(error);
|
|
10
24
|
}
|
|
11
25
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"uptimeKumaStatus.js","sourceRoot":"","sources":["../../src/tools/uptimeKumaStatus.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;
|
|
1
|
+
{"version":3,"file":"uptimeKumaStatus.js","sourceRoot":"","sources":["../../src/tools/uptimeKumaStatus.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAExD,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,YAAY,GAAG,aAAa,CAAC;AAEnC,SAAS,OAAO;IACd,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;IACtD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,MAAiB;IACxC,MAAM,CAAC,IAAI,CACT,0BAA0B,EAC1B,4CAA4C,EAC5C,EAAE,EACF,KAAK,IAAI,EAAE;QACT,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAC1B,8BAA8B,IAAI,qCAAqC,CACxE,CAAC;YAEF,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,IAAI,KAAK,YAAY,kBAAkB,EAAE,CAAC;gBACxC,IAAI,KAAK,CAAC,QAAQ,KAAK,CAAC,EAAE,CAAC;oBACzB,OAAO,aAAa,CAClB,IAAI,KAAK,CACP,wBAAwB,YAAY,YAAY,IAAI,mBAAmB;wBACrE,2DAA2D,CAC9D,CACF,CAAC;gBACJ,CAAC;YACH,CAAC;YACD,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.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "MCP server for home lab operations via SSH - 20 tools for system status, Docker Compose management, service health, monitoring, networking, backups, and administration on a Raspberry Pi.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|