@yawlabs/ssh-mcp 0.3.0 → 0.5.0

package/dist/server.d.ts

@@ -1,7 +1,55 @@
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-import { Client } from 'ssh2';
+import { ConnectConfig, Client } from 'ssh2';
 
-declare function registerTools(server: McpServer): void;
+interface SSHConfig {
+    host: string;
+    port?: number;
+    username?: string;
+    privateKeyPath?: string;
+    password?: string;
+    agent?: string;
+}
+interface ExecResult {
+    stdout: string;
+    stderr: string;
+    code: number;
+}
+interface ResolvedConfig {
+    connectConfig: ConnectConfig;
+    proxyJump?: string;
+}
+declare function resolveConfig(config: SSHConfig): ResolvedConfig;
+declare function formatDiagnostics(host: string): string;
+declare function connectRaw(connectConfig: ConnectConfig): Promise<Client>;
+declare function connectWithProxy(resolved: ResolvedConfig): Promise<Client>;
+declare function connect(config: SSHConfig): Promise<Client>;
+declare function exec(client: Client, command: string, timeoutMs?: number): Promise<ExecResult>;
+declare function readFile(client: Client, remotePath: string): Promise<string>;
+declare function writeFile(client: Client, remotePath: string, content: string): Promise<void>;
+declare function uploadFile(client: Client, localPath: string, remotePath: string): Promise<void>;
+declare function downloadFile(client: Client, remotePath: string, localPath: string): Promise<void>;
+declare function listDir(client: Client, remotePath: string): Promise<string[]>;
+
+interface PoolOptions {
+    /** Milliseconds before an idle connection is closed. Default: 60000 (60s) */
+    idleTtlMs?: number;
+}
+declare class ConnectionPool {
+    private entries;
+    private idleTtlMs;
+    constructor(options?: PoolOptions);
+    acquire(config: SSHConfig): Promise<Client>;
+    release(client: Client): void;
+    withConnection<T>(config: SSHConfig, fn: (client: Client) => Promise<T>): Promise<T>;
+    drain(): void;
+    get size(): number;
+    get stats(): {
+        active: number;
+        idle: number;
+    };
+}
+
+declare function registerTools(server: McpServer, pool?: ConnectionPool): void;
 
 interface DiagnosticResult {
     status: "ok" | "warning" | "error";
@@ -21,26 +69,42 @@ declare function checkConnectivity(host: string, port?: number): DiagnosticResul
 declare function checkSshConfig(host: string): DiagnosticResult;
 declare function diagnose(host: string, port?: number): DiagnosticReport;
 
-interface SSHConfig {
+interface MultiExecResult {
+    host: string;
+    stdout: string;
+    stderr: string;
+    code: number;
+    error?: string;
+}
+interface MultiExecHost {
     host: string;
     port?: number;
     username?: string;
     privateKeyPath?: string;
     password?: string;
-    agent?: string;
 }
-interface ExecResult {
-    stdout: string;
-    stderr: string;
-    code: number;
+declare function multiExec(pool: ConnectionPool, hosts: MultiExecHost[], command: string, timeoutMs?: number): Promise<MultiExecResult[]>;
+interface FindOptions {
+    path: string;
+    name?: string;
+    type?: "f" | "d" | "l";
+    maxdepth?: number;
+    minsize?: string;
+    maxsize?: string;
+    newer?: string;
 }
-declare function connect(config: SSHConfig): Promise<Client>;
-declare function exec(client: Client, command: string, timeoutMs?: number): Promise<ExecResult>;
-declare function readFile(client: Client, remotePath: string): Promise<string>;
-declare function writeFile(client: Client, remotePath: string, content: string): Promise<void>;
-declare function uploadFile(client: Client, localPath: string, remotePath: string): Promise<void>;
-declare function downloadFile(client: Client, remotePath: string, localPath: string): Promise<void>;
-declare function listDir(client: Client, remotePath: string): Promise<string[]>;
+declare function find(client: Client, options: FindOptions, timeoutMs?: number): Promise<string[]>;
+declare function tail(client: Client, path: string, lines?: number, grep?: string, timeoutMs?: number): Promise<string>;
+interface ServiceStatus {
+    name: string;
+    active: boolean;
+    status: string;
+    description?: string;
+    since?: string;
+    pid?: number;
+    raw: string;
+}
+declare function serviceStatus(client: Client, serviceName: string, timeoutMs?: number): Promise<ServiceStatus>;
 
 interface KeyInfo {
     name: string;
@@ -95,6 +159,6 @@ declare function testConnection(host: string, port?: number): {
     message: string;
 };
 
-declare function createServer(): McpServer;
+declare function createServer(pool?: ConnectionPool): McpServer;
 
-export { type AgentResult, type ConfigLookupResult, type DiagnosticReport, type DiagnosticResult, type ExecResult, type KeyInfo, type SSHConfig, checkConnectivity, checkGitSsh, checkKnownHosts, checkSshAgent, checkSshConfig, checkSshKeys, configLookup, connect, createServer, diagnose, downloadFile, ensureAgent, exec, fixKnownHosts, listDir, listSshKeys, loadKey, readFile, registerTools, testConnection, uploadFile, writeFile };
+export { type AgentResult, type ConfigLookupResult, ConnectionPool, type DiagnosticReport, type DiagnosticResult, type ExecResult, type FindOptions, type KeyInfo, type MultiExecHost, type MultiExecResult, type PoolOptions, type ResolvedConfig, type SSHConfig, type ServiceStatus, checkConnectivity, checkGitSsh, checkKnownHosts, checkSshAgent, checkSshConfig, checkSshKeys, configLookup, connect, connectRaw, connectWithProxy, createServer, diagnose, downloadFile, ensureAgent, exec, find, fixKnownHosts, formatDiagnostics, listDir, listSshKeys, loadKey, multiExec, readFile, registerTools, resolveConfig, serviceStatus, tail, testConnection, uploadFile, writeFile };