Implement roadmap configValidate: probe every configured service

Aberta
#154 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
62/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
node.js, typescript
Domínio
devops, tooling

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
TypeScript
Estrelas
0
Forks
4
Merge médio
10h 16min
PRs com merge (30d)
2

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de TMHSDigital/Home-Lab-Developer-Tools

Todas as issues de TMHSDigital/Home-Lab-Developer-Tools

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.