Implement roadmap configValidate: probe every configured service

未关闭
#154 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
62/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
领域
devops, tooling

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
TypeScript
星标
0
派生
4
平均合并
10 小时 16 分钟
30 天内合并 PR
2

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/Home-Lab-Developer-Tools 的其他 Issue

查看 TMHSDigital/Home-Lab-Developer-Tools 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。