Implement roadmap configValidate: probe every configured service

Offen
#154 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
62/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
node.js, typescript
Bereich
devops, tooling

Rechercherichtung

Read mcp-server/src/utils/service-http.ts first: the SERVICES registry and curlErrorResponse are the pieces the new tool reuses, then look at how mcp-server/src/tools/healthCheck.ts registers and shapes its tool result. Check ROADMAP.md around lines 255-256 for the intended scope, and settle the open question of a separate tool versus folding into healthCheck with the maintainer before writing code. Run cd mcp-server && npm install && npm test and npm run typecheck to see the existing test style. Done means one call returns PASS / FAIL / NOT CONFIGURED per service for a given node or all, with no secret values in the output.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

enhancement help wanted severity: medium

Summary

homelab_configValidate and homelab_configExport are planned in ROADMAP.md but not built; healthCheck only checks that binaries exist.

Where

  • ROADMAP.md:255-256
  • mcp-server/src/tools/healthCheck.ts:76
  • mcp-server/src/utils/service-http.ts:19-46 (SERVICES registry)

Details

The SERVICES registry already knows each service's name, port variable and default port, and curlErrorResponse already distinguishes auth from connection failures.

Impact

New users discover a wrong port or missing credential one tool at a time (for example AdGuard and Grafana both default to 3000). A single "is my config right" call is the onboarding step the roadmap planned.

Suggested fix

Implement homelab_configValidate: parse HOMELAB_NODES locally, check each key file is readable, then in one SSH round trip per node probe each SERVICES entry with its configured port and credentials, reporting PASS / FAIL / NOT CONFIGURED with the existing hints. Support node: "all". configExport can reuse the same resolution with secret values masked.

Open question: fold into healthCheck or keep a separate tool as the roadmap says?

Acceptance criteria

  • One call reports per-service PASS/FAIL/NOT CONFIGURED
  • No secret values in output

Getting started

  • Relevant files: mcp-server/src/tools/healthCheck.ts, mcp-server/src/utils/service-http.ts, ROADMAP.md
  • How to run tests: cd mcp-server && npm install && npm test (and npm run typecheck); structure tests: pip install -r requirements-test.txt && pytest tests/ -v
  • Conventions: see CLAUDE.md and CONTRIBUTING.md

Filed by repo-audit/full-audit at 636fefb. Severity: medium. Effort: M. audit-key: enhancement|mcp-server/src/tools/healthCheck.ts|homelab_configValidate

Vorherrschende Sprache
TypeScript
Sterne
0
Forks
4
Ø Merge
10 Std. 16 Min.
Gemergte PRs (30 T.)
2

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/Home-Lab-Developer-Tools

Alle Issues in TMHSDigital/Home-Lab-Developer-Tools

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.