synapse-mcp 1.0.0

package/dist/formatters/index.d.ts

@@ -0,0 +1,275 @@
+/**
+ * Formatting utilities for homelab MCP responses
+ *
+ * Provides consistent markdown formatting for container, host, and Docker data.
+ */
+import { formatBytes } from "../services/docker.js";
+import type { ContainerInfo, ImageInfo } from "../types.js";
+import type { ComposeProject } from "../services/compose.js";
+export { formatBytes };
+/**
+ * Truncate text if it exceeds CHARACTER_LIMIT
+ */
+export declare function truncateIfNeeded(text: string): string;
+/**
+ * Format container list as markdown
+ */
+export declare function formatContainersMarkdown(containers: ContainerInfo[], total: number, offset: number, hasMore: boolean): string;
+/**
+ * Format container logs as markdown
+ */
+export declare function formatLogsMarkdown(logs: Array<{
+    timestamp: string;
+    message: string;
+}>, container: string, host: string): string;
+/**
+ * Container stats type for formatting
+ */
+export interface ContainerStats {
+    containerName: string;
+    cpuPercent: number;
+    memoryUsage: number;
+    memoryLimit: number;
+    memoryPercent: number;
+    networkRx: number;
+    networkTx: number;
+    blockRead: number;
+    blockWrite: number;
+}
+/**
+ * Format single container stats as markdown
+ */
+export declare function formatStatsMarkdown(stats: ContainerStats[], host: string): string;
+/**
+ * Format multiple container stats as markdown table
+ */
+export declare function formatMultiStatsMarkdown(allStats: Array<{
+    stats: ContainerStats;
+    host: string;
+}>): string;
+/**
+ * Container inspect info type for formatting
+ */
+export interface ContainerInspectInfo {
+    Name: string;
+    RestartCount: number;
+    State: {
+        Status: string;
+        Running: boolean;
+        StartedAt: string;
+    };
+    Config: {
+        Image: string;
+        Cmd?: string[];
+        WorkingDir?: string;
+        Env?: string[];
+    };
+    Mounts?: Array<{
+        Source: string;
+        Destination: string;
+        Mode?: string;
+    }>;
+    NetworkSettings: {
+        Ports?: Record<string, Array<{
+            HostIp: string;
+            HostPort: string;
+        }> | null>;
+        Networks?: Record<string, unknown>;
+    };
+}
+/**
+ * Format container inspection as markdown
+ */
+export declare function formatInspectMarkdown(info: ContainerInspectInfo, host: string): string;
+/**
+ * Host status entry type
+ */
+export interface HostStatusEntry {
+    name: string;
+    connected: boolean;
+    containerCount: number;
+    runningCount: number;
+    error?: string;
+}
+/**
+ * Format host status as markdown table
+ */
+export declare function formatHostStatusMarkdown(status: HostStatusEntry[]): string;
+/**
+ * Format search results as markdown
+ */
+export declare function formatSearchResultsMarkdown(containers: ContainerInfo[], query: string, total: number): string;
+/**
+ * Docker info type for formatting
+ */
+export interface DockerInfoResult {
+    dockerVersion: string;
+    apiVersion: string;
+    os: string;
+    arch: string;
+    kernelVersion: string;
+    cpus: number;
+    memoryBytes: number;
+    storageDriver: string;
+    rootDir: string;
+    containersRunning: number;
+    containersTotal: number;
+    images: number;
+}
+/**
+ * Format Docker info as markdown
+ */
+export declare function formatDockerInfoMarkdown(results: Array<{
+    host: string;
+    info: DockerInfoResult;
+}>): string;
+/**
+ * Docker disk usage type for formatting
+ */
+export interface DockerDiskUsage {
+    images: {
+        total: number;
+        active: number;
+        size: number;
+        reclaimable: number;
+    };
+    containers: {
+        total: number;
+        running: number;
+        size: number;
+        reclaimable: number;
+    };
+    volumes: {
+        total: number;
+        active: number;
+        size: number;
+        reclaimable: number;
+    };
+    buildCache: {
+        total: number;
+        size: number;
+        reclaimable: number;
+    };
+    totalSize: number;
+    totalReclaimable: number;
+}
+/**
+ * Format Docker disk usage as markdown
+ */
+export declare function formatDockerDfMarkdown(results: Array<{
+    host: string;
+    usage: DockerDiskUsage;
+}>): string;
+/**
+ * Prune result type for formatting
+ */
+export interface PruneResult {
+    type: string;
+    spaceReclaimed: number;
+    itemsDeleted: number;
+}
+/**
+ * Format prune results as markdown
+ */
+export declare function formatPruneMarkdown(allResults: Array<{
+    host: string;
+    results: PruneResult[];
+}>): string;
+/**
+ * Host resources type for formatting
+ */
+export interface HostResources {
+    hostname: string;
+    uptime: string;
+    loadAverage: number[];
+    cpu: {
+        cores: number;
+        usagePercent: number;
+    };
+    memory: {
+        totalMB: number;
+        usedMB: number;
+        usagePercent: number;
+    };
+    disk: Array<{
+        mount: string;
+        totalGB: number;
+        usedGB: number;
+        usagePercent: number;
+    }>;
+}
+/**
+ * Format host resources as markdown
+ */
+export declare function formatHostResourcesMarkdown(results: Array<{
+    host: string;
+    resources: HostResources | null;
+    error?: string;
+}>): string;
+/**
+ * Format images list as markdown table
+ */
+export declare function formatImagesMarkdown(images: ImageInfo[], total: number, offset: number): string;
+/**
+ * Format compose project list as markdown
+ */
+export declare function formatComposeListMarkdown(projects: ComposeProject[], host: string, total?: number, offset?: number, hasMore?: boolean): string;
+/**
+ * Format compose project status as markdown
+ */
+export declare function formatComposeStatusMarkdown(project: ComposeProject, totalServices?: number, offset?: number, hasMore?: boolean): string;
+/**
+ * Container inspect summary type
+ */
+export interface ContainerInspectSummary {
+    id: string;
+    name: string;
+    image: string;
+    state: string;
+    created: string;
+    started: string;
+    restartCount: number;
+    ports: string[];
+    mounts: Array<{
+        src?: string;
+        dst?: string;
+        type?: string;
+    }>;
+    networks: string[];
+    env_count: number;
+    labels_count: number;
+    host: string;
+}
+/**
+ * Format container inspect summary as markdown (condensed version)
+ */
+export declare function formatInspectSummaryMarkdown(summary: ContainerInspectSummary): string;
+/**
+ * Format file read result as markdown
+ */
+export declare function formatScoutReadMarkdown(host: string, path: string, content: string, size: number, truncated: boolean): string;
+/**
+ * Format directory listing as markdown
+ */
+export declare function formatScoutListMarkdown(host: string, path: string, listing: string): string;
+/**
+ * Format tree output as markdown
+ */
+export declare function formatScoutTreeMarkdown(host: string, path: string, tree: string, depth: number): string;
+/**
+ * Format command execution result as markdown
+ */
+export declare function formatScoutExecMarkdown(host: string, path: string, command: string, stdout: string, exitCode: number): string;
+/**
+ * Format find results as markdown
+ */
+export declare function formatScoutFindMarkdown(host: string, path: string, pattern: string, results: string): string;
+/**
+ * Format file transfer result as markdown
+ */
+export declare function formatScoutTransferMarkdown(sourceHost: string, sourcePath: string, targetHost: string, targetPath: string, bytesTransferred: number, warning?: string): string;
+/**
+ * Format file diff result as markdown
+ */
+export declare function formatScoutDiffMarkdown(host1: string, path1: string, host2: string, path2: string, diff: string): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/formatters/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/formatters/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC5D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAG7D,OAAO,EAAE,WAAW,EAAE,CAAC;AAEvB;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAMrD;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,aAAa,EAAE,EAC3B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,GACf,MAAM,CA2BR;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,KAAK,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAAC,EACnD,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,GACX,MAAM,CAaR;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAYjF;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,KAAK,CAAC;IAAE,KAAK,EAAE,cAAc,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GACvD,MAAM,CAiBR;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,MAAM,EAAE;QACN,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;KAChB,CAAC;IACF,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC,CAAC;IACH,eAAe,EAAE;QACf,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAA;SAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC;CACH;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CA6DtF;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,CAiB1E;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,aAAa,EAAE,EAC3B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,MAAM,CAaR;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,CAAC,GACvD,MAAM,CAoBR;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC7E,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAClF,OAAO,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9E,UAAU,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IACjE,SAAS,EAAE,MAAM,CAAC;IAClB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,eAAe,CAAA;CAAE,CAAC,GACvD,MAAM,CA6BR;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,WAAW,EAAE,CAAA;CAAE,CAAC,GAC1D,MAAM,CAyBR;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,GAAG,EAAE;QACH,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,IAAI,EAAE,KAAK,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,aAAa,GAAG,IAAI,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GAChF,MAAM,CA8BR;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAoB/F;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,cAAc,EAAE,EAC1B,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,MAAM,CAuBR;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,cAAc,EACvB,aAAa,CAAC,EAAE,MAAM,EACtB,MAAM,CAAC,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,MAAM,CAiCR;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC7D,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,uBAAuB,GAAG,MAAM,CA0BrF;AAID;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,OAAO,GACjB,MAAM,CAiBR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAE3F;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,MAAM,CAIR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GACf,MAAM,CAgBR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,MAAM,CAeR;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE,MAAM,GACf,MAAM,CAeR;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GACX,MAAM,CAaR"}