HTTP service tools copy the same curl/port/error pattern and have drifted

Aperta
#152 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à
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
tooling

Direzione di ricerca

Start in mcp-server/src/utils/service-http.ts to see the existing execSSH, curlErrorResponse and completeJson helpers, then compare mcp-server/src/tools/adguardStats.ts (unguarded) against mcp-server/src/tools/npmCerts.ts (guarded) and certList.ts (duplicated NPM call). Run cd mcp-server && npm install && npm test plus npm run typecheck to get a baseline before changing anything. Done means every HTTP tool routes through the new serviceGet/servicePost/npmGet helpers and each JSON tool applies the truncation guard, with handler tests pinning commands and results for curl exit codes 7, 22 and 28.

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

Descrizione

help wanted severity: medium tech-debt

Summary

#103 centralized ports and auth, but about 16 tools still copy the same handler body, and the copies now differ in truncation handling and error text.

Where

  • mcp-server/src/tools/adguardStats.ts:18-30
  • mcp-server/src/tools/npmCerts.ts:19-31
  • mcp-server/src/tools/certList.ts:44-65
  • mcp-server/src/tools/alertList.ts:39-42
  • mcp-server/src/tools/speedtestResults.ts:33-35
  • mcp-server/src/tools/uptimeKumaStatus.ts:39-50

Details

Pattern: let port = SERVICE.defaultPort; try { port = servicePort(...); const output = await execSSH(curl -sf ...); ... } catch (e) { return curlErrorResponse(e, SERVICE, port) }. The completeJson truncation guard (#117) is used by npmCerts, npmProxyHosts, grafanaSnapshot, adguardQueryLog, prometheusQuery, alertSilences and backupList, but not by adguardStats, adguardFilters, alertList, speedtestResults, uptimeKumaStatus or certList. certList builds its own NPM call and error text, duplicating npmCerts line for line.

Impact

Fixes to HTTP handling have to land in 16 places, and history shows they land in only some. Oversized responses from the six unguarded tools reach the model as cut JSON with no explanation.

Steps to reproduce

  1. Set HOMELAB_MAX_OUTPUT_BYTES=100
  2. Call homelab_adguardStats: returns a truncated non-JSON fragment; npmCerts returns the explicit truncation error

Suggested fix

  1. Add serviceGet(service, node, path, { auth?, json? }) and servicePost(...) to service-http.ts: build the curl command, run execSSH, apply completeJson when json, map errors with curlErrorResponse.
  2. Migrate the read-only GET tools one per commit, keeping each tool's formatter.
  3. Add npmGet(node, path) and use it in npmCerts, npmProxyHosts and certList.

Before starting: for each migrated tool, a handler test that pins the exact command and the result for curl exit codes 7, 22 and 28 and for truncated output.

Acceptance criteria

  • All HTTP tools go through the shared helpers
  • Every JSON-returning tool applies the truncation guard

Related: #103, #117

Getting started

  • Relevant files: mcp-server/src/utils/service-http.ts, mcp-server/src/tools/adguardStats.ts, mcp-server/src/tools/certList.ts, mcp-server/src/tools/npmCerts.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: tech-debt|mcp-server/src/utils/service-http.ts|curlErrorResponse

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.