Implement roadmap configValidate: probe every configured service

Đang mở
#154 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
62/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
node.js, typescript
Lĩnh vực
devops, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
TypeScript
Star
0
Fork
4
Merge trung bình
10 giờ 16 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/Home-Lab-Developer-Tools

Tất cả issue của TMHSDigital/Home-Lab-Developer-Tools

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.