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

Ouverte
#152 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
45/100
Type d'issue
Refactorisation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
typescript
Domaine
tooling

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
TypeScript
Étoiles
0
Forks
4
Merge moyen
10 h 16 min
PR mergées (30 j)
2

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/Home-Lab-Developer-Tools

Toutes les issues de TMHSDigital/Home-Lab-Developer-Tools

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.