Return structuredContent with an outputSchema from status tools

Đang mở
#156 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
60/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ệ
docker, node.js, typescript
Lĩnh vực
api, tooling

Hướng nghiên cứu

Open mcp-server/src/tools/serviceHealth.ts first — the zod docker-ps schema already exists and is flattened to text around lines 206-233; compare with healthCheck.ts:95-110 and the forNodes helper in mcp-server/src/utils/fan-out.ts:18, which only returns text. Read CLAUDE.md and CONTRIBUTING.md for the registerTool convention, then declare outputSchema per tool and return structuredContent alongside the unchanged text. Run cd mcp-server && npm install && npm test plus npm run typecheck; done means the listed tools validate structured results while text output stays byte-identical.

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

Mô tả

enhancement severity: medium

Summary

No tool declares outputSchema or returns structuredContent, although several already parse into typed data and then flatten it to text.

Where

  • mcp-server/src/tools/serviceHealth.ts:206-233
  • mcp-server/src/tools/healthCheck.ts:95-110
  • mcp-server/src/utils/fan-out.ts:18

Details

serviceHealth parses docker ps JSON with a zod schema; healthCheck builds CheckResult[]; forNodes returns only text.

Impact

Clients and agents that chain tools (fleet dashboards, "which nodes have unhealthy containers") must re-parse prose.

Suggested fix

Start with serviceHealth, healthCheck, piStatus, nodeList and backupStatus: declare outputSchema in registerTool and return both the current text and structuredContent. Let forNodes accept a structured per-node result and return { nodes: [{ name, host, ok, data | error }] }.

Open question: keep text output identical for prompts and skills?

Acceptance criteria

  • Listed tools return validated structuredContent
  • Text output unchanged

Getting started

  • Relevant files: mcp-server/src/tools/serviceHealth.ts, mcp-server/src/tools/healthCheck.ts, mcp-server/src/utils/fan-out.ts
  • 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/utils/fan-out.ts|structuredContent

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.