Return structuredContent with an outputSchema from status tools

未關閉
#156 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
1-2 天
新手友好度
60/100
Issue 類型
功能
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
docker, node.js, typescript
領域
api, tooling

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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

主要語言
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 摘要。