Return structuredContent with an outputSchema from status tools

Aperta
#156 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
60/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker, node.js, typescript
Ambito
api, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
TypeScript
Stelle
0
Fork
4
Merge medio
10h 16m
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di TMHSDigital/Home-Lab-Developer-Tools

Tutte le issue di TMHSDigital/Home-Lab-Developer-Tools

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.