synapse-mcp 1.0.0 → 1.0.2

package/dist/formatters/scout.d.ts

@@ -0,0 +1,424 @@
+/**
+ * Scout (SSH) operation formatting utilities
+ *
+ * Provides consistent markdown formatting for file operations:
+ * read, list, tree, exec, find, transfer, and diff.
+ *
+ * ## STYLE.md Compliance
+ *
+ * All formatters follow STYLE.md specifications:
+ * - Section 3.1: Plain text titles (no markdown ## prefix)
+ * - Section 4.1: Canonical symbols only (✓✗⚠, NO emoji)
+ * - Section 3.6: Freshness timestamps for volatile operations (TODO: Phase 2.2)
+ * - Section 3.2: Summary lines (TODO: Phase 2.2)
+ *
+ * Symbol Legend:
+ * - ✓ = Success (command exit 0)
+ * - ✗ = Error (command exit non-zero)
+ * - ⚠ = Warning (truncation, non-fatal issues)
+ */
+/**
+ * Format file read result as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated segments
+ * Warning symbol: ⚠ (canonical non-emoji variant)
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutReadMarkdown("squirts", "/etc/hostname", "squirts\n", 8, false);
+ * // Returns:
+ * // File Read: squirts:/etc/hostname
+ * // Size: 8.0 B | truncated: no
+ * //
+ * // ```
+ * // squirts
+ * // ```
+ * ```
+ */
+export declare function formatScoutReadMarkdown(host: string, path: string, content: string, size: number, truncated: boolean): string;
+/**
+ * Format directory listing as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated segments
+ *
+ * @example
+ * ```ts
+ * formatScoutListMarkdown("squirts", "/etc", "file1\nfile2\nfile3");
+ * // Directory Listing: squirts:/etc
+ * // Items: 3
+ * //
+ * // ```
+ * // file1
+ * // file2
+ * // file3
+ * // ```
+ * ```
+ */
+export declare function formatScoutListMarkdown(host: string, path: string, listing: string): string;
+/**
+ * Format tree output as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Depth displayed as separate line
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutTreeMarkdown("squirts", "/opt", "dir1/\n  file1\ndir2/", 2);
+ * // Returns:
+ * // Directory Tree: squirts:/opt
+ * // Depth: 2
+ * //
+ * // ```
+ * // dir1/
+ * //   file1
+ * // dir2/
+ * // ```
+ * ```
+ */
+export declare function formatScoutTreeMarkdown(host: string, path: string, tree: string, depth: number): string;
+/**
+ * Format command execution result as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Symbols per STYLE.md 4.1: ✓ for success, ✗ for error
+ * Freshness per STYLE.md 3.6: Command execution is volatile data
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutExecMarkdown("squirts", "/tmp", "uptime", "15:23:45 up 3 days", 0);
+ * // Returns:
+ * // ✓ Command Execution: squirts:/tmp
+ * // Exit: 0
+ * // As of (EST): 11:05:20 | 02/13/2026
+ * //
+ * // **Command:** `uptime`
+ * // **Exit:** 0
+ * //
+ * // **Output:**
+ * // ```
+ * // 15:23:45 up 3 days
+ * // ```
+ * ```
+ */
+export declare function formatScoutExecMarkdown(host: string, path: string, command: string, stdout: string, exitCode: number): string;
+/**
+ * Format find results as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pattern and result count in pipe-separated format
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutFindMarkdown("squirts", "/opt", "*.log", "access.log\nerror.log");
+ * // Returns:
+ * // Find Results: squirts:/opt
+ * // Pattern: *.log | Results: 2
+ * //
+ * // **Pattern:** `*.log`
+ * // **Results:** 2 files
+ * //
+ * // ```
+ * // access.log
+ * // error.log
+ * // ```
+ * ```
+ */
+export declare function formatScoutFindMarkdown(host: string, path: string, pattern: string, results: string): string;
+/**
+ * Format file transfer result as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Source, target, and size in pipe-separated format
+ * Warning symbol: ⚠ (canonical non-emoji variant)
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutTransferMarkdown("squirts", "/data/backup.tar", "boops", "/backups/backup.tar", 10485760);
+ * // Returns:
+ * // File Transfer Complete
+ * // From: squirts | To: boops | Size: 10.0 MB
+ * //
+ * // **From:** squirts:/data/backup.tar
+ * // **To:** boops:/backups/backup.tar
+ * // **Size:** 10.0 MB
+ * ```
+ */
+export declare function formatScoutTransferMarkdown(sourceHost: string, sourcePath: string, targetHost: string, targetPath: string, bytesTransferred: number, warning?: string): string;
+/**
+ * Format file diff result as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Both file paths in pipe-separated format
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutDiffMarkdown("squirts", "/etc/config.old", "boops", "/etc/config.new", "- old line\n+ new line");
+ * // Returns:
+ * // File Diff
+ * // File 1: squirts:/etc/config.old | File 2: boops:/etc/config.new
+ * //
+ * // **File 1:** squirts:/etc/config.old
+ * // **File 2:** boops:/etc/config.new
+ * //
+ * // ```diff
+ * // - old line
+ * // + new line
+ * // ```
+ * ```
+ */
+export declare function formatScoutDiffMarkdown(host1: string, path1: string, host2: string, path2: string, diff: string): string;
+/**
+ * Format list of hosts as markdown table
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Host count
+ * Table format per STYLE.md 7.2: ASCII table with aligned columns
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutNodesMarkdown(["squirts", "boops", "nicks"]);
+ * // Returns:
+ * // Scout Nodes
+ * // Hosts: 3
+ * //
+ * // | Host |
+ * // |------|
+ * // | squirts |
+ * // | boops |
+ * // | nicks |
+ * ```
+ */
+export declare function formatScoutNodesMarkdown(hosts: string[]): string;
+/**
+ * Format process listing as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Process count
+ * Freshness per STYLE.md 3.6: Process data is volatile
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutPsMarkdown("squirts", "  PID COMMAND\n 1234 nginx\n 5678 node\n 9012 postgres");
+ * // Returns:
+ * // Process Listing: squirts
+ * // Processes: 3
+ * // As of (EST): 11:27:00 | 02/13/2026
+ * //
+ * // ```
+ * //   PID COMMAND
+ * //  1234 nginx
+ * //  5678 node
+ * //  9012 postgres
+ * // ```
+ * ```
+ */
+export declare function formatScoutPsMarkdown(host: string, processes: string): string;
+/**
+ * Format disk usage as markdown with warnings for high usage
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Filesystem count
+ * Freshness per STYLE.md 3.6: Disk data is volatile
+ * Warning per STYLE.md 10.2: ⚠ for filesystems >85% usage
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutDfMarkdown("squirts", "Filesystem     Size  Used Avail Use% Mounted on\n/dev/sda1      100G   90G   10G  90% /\n/dev/sdb1       50G   20G   30G  40% /data");
+ * // Returns:
+ * // Disk Usage: squirts
+ * // Filesystems: 2 ⚠
+ * // As of (EST): 11:28:20 | 02/13/2026
+ * //
+ * // ```
+ * // Filesystem     Size  Used Avail Use% Mounted on
+ * // /dev/sda1      100G   90G   10G  90% /
+ * // /dev/sdb1       50G   20G   30G  40% /data
+ * // ```
+ * //
+ * // ⚠ *One or more filesystems exceed 85% usage*
+ * ```
+ */
+export declare function formatScoutDfMarkdown(host: string, diskUsage: string): string;
+/**
+ * Format syslog output as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Lines count
+ * Freshness per STYLE.md 3.6: Log data is volatile
+ * Request echo per STYLE.md 3.5: Show lines requested and optional grep filter
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutSyslogMarkdown("squirts", 50, "Feb 13 11:00:00 squirts sshd[1234]: Accepted key for user from 192.168.1.1\nFeb 13 11:01:00 squirts systemd[1]: Started session.", "sshd");
+ * // Returns:
+ * // Syslog: squirts
+ * // Lines requested: 50 | Returned: 2 | Filter: sshd
+ * // As of (EST): 11:29:50 | 02/13/2026
+ * //
+ * // ```
+ * // Feb 13 11:00:00 squirts sshd[1234]: Accepted key for user from 192.168.1.1
+ * // Feb 13 11:01:00 squirts systemd[1]: Started session.
+ * // ```
+ * ```
+ */
+export declare function formatScoutSyslogMarkdown(host: string, linesRequested: number, logs: string, grepFilter?: string): string;
+/**
+ * Format journal (journalctl) output as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Lines count
+ * Freshness per STYLE.md 3.6: Log data is volatile
+ * Request echo per STYLE.md 3.5: Show lines requested and optional grep filter
+ *
+ * @example
+ * ```ts
+ * const output = formatScoutJournalMarkdown("squirts", 50, "Feb 13 11:30:00 squirts systemd[1]: Started service\nFeb 13 11:31:00 squirts systemd[1]: Stopped service");
+ * // Returns:
+ * // Journal: squirts
+ * // Lines requested: 50 | Returned: 2
+ * // As of (EST): 11:30:20 | 02/13/2026
+ * //
+ * // ```
+ * // Feb 13 11:30:00 squirts systemd[1]: Started service
+ * // Feb 13 11:31:00 squirts systemd[1]: Stopped service
+ * // ```
+ * ```
+ */
+export declare function formatScoutJournalMarkdown(host: string, linesRequested: number, logs: string, grepFilter?: string): string;
+/**
+ * Format kernel ring buffer (dmesg) logs as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated with request echo
+ * Request echo per STYLE.md 3.5: Shows lines requested parameter
+ * Freshness per STYLE.md 3.6: Volatile kernel log data
+ *
+ * @param host - Host name the logs are from
+ * @param linesRequested - Number of lines requested from dmesg
+ * @param logs - Raw dmesg log output
+ * @param grepFilter - Optional grep pattern applied to logs
+ * @returns Formatted markdown string
+ *
+ * @example
+ * ```typescript
+ * const output = formatScoutDmesgMarkdown("squirts", 100, "[    0.000000] Linux version 6.1.0-generic\n[    0.001234] Command line: BOOT_IMAGE=/boot/vmlinuz");
+ * // Dmesg: squirts
+ * // Lines requested: 100 | Returned: 2
+ * // As of (EST): 11:45:30 | 02/13/2026
+ * //
+ * // ```
+ * // [    0.000000] Linux version 6.1.0-generic
+ * // [    0.001234] Command line: BOOT_IMAGE=/boot/vmlinuz
+ * // ```
+ * ```
+ */
+export declare function formatScoutDmesgMarkdown(host: string, linesRequested: number, logs: string, grepFilter?: string): string;
+/**
+ * Format authentication logs as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated with request echo
+ * Request echo per STYLE.md 3.5: Shows lines requested parameter
+ * Freshness per STYLE.md 3.6: Volatile authentication log data
+ *
+ * @param host - Host name the logs are from
+ * @param linesRequested - Number of lines requested from auth log
+ * @param logs - Raw authentication log output
+ * @param grepFilter - Optional grep pattern applied to logs
+ * @returns Formatted markdown string
+ *
+ * @example
+ * ```typescript
+ * const output = formatScoutAuthMarkdown("squirts", 50, "Feb 13 11:00:00 squirts sshd[1234]: Accepted publickey for user from 192.168.1.100\nFeb 13 11:00:05 squirts sshd[1234]: pam_unix(sshd:session): session opened");
+ * // Auth Logs: squirts
+ * // Lines requested: 50 | Returned: 2
+ * // As of (EST): 11:00:30 | 02/13/2026
+ * //
+ * // ```
+ * // Feb 13 11:00:00 squirts sshd[1234]: Accepted publickey for user from 192.168.1.100
+ * // Feb 13 11:00:05 squirts sshd[1234]: pam_unix(sshd:session): session opened
+ * // ```
+ * ```
+ */
+export declare function formatScoutAuthMarkdown(host: string, linesRequested: number, logs: string, grepFilter?: string): string;
+/**
+ * Format ZFS pool list as markdown with health status symbols
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated pool count
+ * Symbols per STYLE.md 4.1: ● for ONLINE, ⚠ for degraded, ✗ for faulted
+ *
+ * Health status mapping:
+ * - ONLINE → ● (healthy)
+ * - DEGRADED/UNAVAIL → ⚠ (warning)
+ * - FAULTED/OFFLINE/REMOVED → ✗ (error)
+ *
+ * @param host - Host name where pools exist
+ * @param pools - Raw zpool list output
+ * @returns Formatted markdown string with health symbols
+ *
+ * @example
+ * ```typescript
+ * const output = formatScoutZfsPoolsMarkdown("squirts", "NAME    SIZE   ALLOC  FREE    HEALTH  ALTROOT\ntank    10.9T  8.2T   2.7T    ONLINE  -");
+ * // ZFS Pools: squirts
+ * // Pools: 1
+ * //
+ * // ```
+ * // NAME    SIZE   ALLOC  FREE    HEALTH   STATUS
+ * // tank    10.9T  8.2T   2.7T    ONLINE   ●
+ * // ```
+ * ```
+ */
+export declare function formatScoutZfsPoolsMarkdown(host: string, pools: string): string;
+/**
+ * Format ZFS datasets with usage warnings
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated dataset count
+ * Warning per STYLE.md 10.2: ⚠ for datasets >85% used
+ *
+ * @param host - Host name where datasets exist
+ * @param datasets - Raw zfs list output
+ * @returns Formatted markdown string with usage warnings
+ *
+ * @example
+ * ```typescript
+ * const output = formatScoutZfsDatasetsMarkdown("squirts", "NAME          USED   AVAIL  REFER  MOUNTPOINT\ntank/media    9.3T   1.0T   9.3T   /mnt/media");
+ * // ZFS Datasets: squirts
+ * // Datasets: 1 ⚠
+ * //
+ * // ```
+ * // NAME          USED   AVAIL  REFER  MOUNTPOINT
+ * // tank/media    9.3T   1.0T   9.3T   /mnt/media
+ * // ```
+ * //
+ * // ⚠ *One or more datasets exceed 85% usage*
+ * ```
+ */
+export declare function formatScoutZfsDatasetsMarkdown(host: string, datasets: string): string;
+/**
+ * Format ZFS snapshots list as markdown
+ *
+ * Title format per STYLE.md 3.1: Plain text, no markdown ## prefix
+ * Summary per STYLE.md 3.2: Pipe-separated snapshot count
+ *
+ * @param host - Host name where snapshots exist
+ * @param snapshots - Raw zfs list -t snapshot output
+ * @returns Formatted markdown string
+ *
+ * @example
+ * ```typescript
+ * const output = formatScoutZfsSnapshotsMarkdown("squirts", "NAME                        USED  REFER\ntank/media@2024-02-13      512M  8.2T");
+ * // ZFS Snapshots: squirts
+ * // Snapshots: 1
+ * //
+ * // ```
+ * // NAME                        USED  REFER
+ * // tank/media@2024-02-13      512M  8.2T
+ * // ```
+ * ```
+ */
+export declare function formatScoutZfsSnapshotsMarkdown(host: string, snapshots: string): string;
+//# sourceMappingURL=scout.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scout.d.ts","sourceRoot":"","sources":["../../src/formatters/scout.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAKH;;;;;;;;;;;;;;;;;;GAkBG;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,CAgBR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAK3F;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,GACZ,MAAM,CAIR;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;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,CAkBR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,MAAM,CAgBR;AAED;;;;;;;;;;;;;;;;;;GAkBG;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,CAgBR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;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,CAcR;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAQhE;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAe7E;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CA0B7E;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,yBAAyB,CACvC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAeR;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,0BAA0B,CACxC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAeR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,wBAAwB,CACtC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAeR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,MAAM,EACZ,cAAc,EAAE,MAAM,EACtB,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAeR;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CA0B/E;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAwCrF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAevF"}