HTTP service tools copy the same curl/port/error pattern and have drifted
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 45/100
- Issue-Typ
- Refactoring
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- typescript
- Bereich
- tooling
Rechercherichtung
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.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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-30mcp-server/src/tools/npmCerts.ts:19-31mcp-server/src/tools/certList.ts:44-65mcp-server/src/tools/alertList.ts:39-42mcp-server/src/tools/speedtestResults.ts:33-35mcp-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
- Set
HOMELAB_MAX_OUTPUT_BYTES=100 - Call
homelab_adguardStats: returns a truncated non-JSON fragment; npmCerts returns the explicit truncation error
Suggested fix
- Add
serviceGet(service, node, path, { auth?, json? })andservicePost(...)to service-http.ts: build the curl command, run execSSH, applycompleteJsonwhenjson, map errors withcurlErrorResponse. - Migrate the read-only GET tools one per commit, keeping each tool's formatter.
- 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(andnpm run typecheck); structure tests:pip install -r requirements-test.txt && pytest tests/ -v - Conventions: see
CLAUDE.mdandCONTRIBUTING.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
- Vorherrschende Sprache
- TypeScript
- Sterne
- 0
- Forks
- 4
- Ø Merge
- 10 Std. 16 Min.
- Gemergte PRs (30 T.)
- 2
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus TMHSDigital/Home-Lab-Developer-Tools
-
speedtestResults ignores count: /api/speedtest/latest returns one resultEvtl. vergeben @laozhej hat das vor 2 Tagen übernommen. Offenbug severity: low
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 80/100
TMHSDigital/Home-Lab-Developer-Tools#160 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Integration tests import tool modules inside tests and can time out under loadEvtl. vergeben @laozhej hat das vor 2 Tagen übernommen. Offengood first issue severity: low testing
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 25/100
TMHSDigital/Home-Lab-Developer-Tools#174 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Grafana dashboard import to complete the export/import round tripEvtl. vergeben @laozhej hat das heute übernommen. Offenenhancement severity: low
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
TMHSDigital/Home-Lab-Developer-Tools#171 ·
Maintainer antworten meist innerhalb von 1 Tag
-
help wanted severity: low testing
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 55/100
TMHSDigital/Home-Lab-Developer-Tools#164 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
enhancement severity: medium
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100
TMHSDigital/Home-Lab-Developer-Tools#159 ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in TMHSDigital/Home-Lab-Developer-Tools
Ähnliche Issues
-
[MCP]: page snapshots in .playwright-mcp/ are not git-ignored (.playwright-cli/ is, since #42318)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
microsoft/playwright#44289 ·
Maintainer antworten meist innerhalb von 1 Tag
-
good first issue
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 65/100
Maintainer antworten meist innerhalb von 1 Tag
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
blamechris/chroxy#9272 ·
Maintainer antworten meist innerhalb von 1 Tag
-
no-repo-link tool-submission
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 66/100
BraveOPotato/NoSignups#2458 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
drmrd/vernacular#1061 ·
Maintainer antworten meist innerhalb von 1 Tag