@yawlabs/ssh-mcp 0.1.0 → 0.4.0

package/dist/server.d.ts

@@ -1,7 +1,49 @@
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
-import { Client } from 'ssh2';
+import { Client, ConnectConfig } 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;
+}
+declare function resolveConfig(config: SSHConfig): ConnectConfig;
+declare function connectRaw(connectConfig: ConnectConfig): 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,27 +63,59 @@ declare function checkConnectivity(host: string, port?: number): DiagnosticResul
 declare function checkSshConfig(host: string): DiagnosticResult;
 declare function diagnose(host: string, port?: number): DiagnosticReport;
 
-interface SSHConfig {
-    host: string;
-    port?: number;
-    username?: string;
-    privateKeyPath?: string;
-    password?: string;
-    agent?: string;
+interface KeyInfo {
+    name: string;
+    path: string;
+    type: string;
+    fingerprint?: string;
+    loadedInAgent: boolean;
 }
-interface ExecResult {
-    stdout: string;
-    stderr: string;
-    code: number;
+interface AgentResult {
+    running: boolean;
+    reachable: boolean;
+    socket?: string;
+    keys: string[];
+    started: boolean;
+    env?: {
+        SSH_AUTH_SOCK?: string;
+        SSH_AGENT_PID?: string;
+    };
+    message: 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 ensureAgent(): AgentResult;
+declare function listSshKeys(): KeyInfo[];
+declare function loadKey(keyPath: string): {
+    status: "ok" | "error";
+    message: string;
+};
+interface ConfigLookupResult {
+    hostname: string;
+    user: string;
+    port: string;
+    identityFile: string[];
+    proxyJump?: string;
+    proxyCommand?: string;
+    all: Record<string, string>;
+    raw: string;
+}
+declare function configLookup(host: string): ConfigLookupResult | {
+    error: string;
+};
+declare function fixKnownHosts(host: string, port?: number): {
+    status: "ok" | "error";
+    message: string;
+    actions: string[];
+};
+declare function checkGitSsh(host?: string, user?: string): {
+    status: "ok" | "error";
+    message: string;
+    authenticatedAs?: string;
+};
+declare function testConnection(host: string, port?: number): {
+    status: "ok" | "warning" | "error";
+    message: string;
+};
 
-declare function createServer(): McpServer;
+declare function createServer(pool?: ConnectionPool): McpServer;
 
-export { checkConnectivity, checkKnownHosts, checkSshAgent, checkSshConfig, checkSshKeys, connect, createServer, diagnose, downloadFile, exec, listDir, readFile, registerTools, uploadFile, writeFile };
+export { type AgentResult, type ConfigLookupResult, ConnectionPool, type DiagnosticReport, type DiagnosticResult, type ExecResult, type KeyInfo, type PoolOptions, type SSHConfig, checkConnectivity, checkGitSsh, checkKnownHosts, checkSshAgent, checkSshConfig, checkSshKeys, configLookup, connect, connectRaw, createServer, diagnose, downloadFile, ensureAgent, exec, fixKnownHosts, listDir, listSshKeys, loadKey, readFile, registerTools, resolveConfig, testConnection, uploadFile, writeFile };