ssh_connect
Establish SSH connections to remote servers using host, username, and authentication details. Supports password and private key methods for secure remote access and operations.
Instructions
Connect to an SSH server
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| connectionId | Yes | Unique identifier for this connection | |
| host | Yes | SSH server hostname or IP address | |
| passphrase | No | Passphrase for private key | |
| password | No | SSH password (if not using key) | |
| port | No | SSH port number | |
| privateKeyPath | No | Path to private key file | |
| username | Yes | SSH username |
Implementation Reference
- src/index.ts:539-597 (handler)Main handler function that parses input using ConnectSSHSchema, creates NodeSSH instance, configures authentication (password or private key), connects to the SSH server, stores connection in pool and context, returns success message.private async handleSSHConnect(args: unknown) { const params = ConnectSSHSchema.parse(args); if (connectionPool.has(params.connectionId)) { throw new McpError( ErrorCode.InvalidParams, `Connection ID '${params.connectionId}' already exists` ); } const ssh = new NodeSSH(); try { const connectConfig: any = { host: params.host, port: params.port, username: params.username, }; if (params.privateKeyPath) { const privateKey = await fs.readFile(params.privateKeyPath, 'utf8'); connectConfig.privateKey = privateKey; if (params.passphrase) { connectConfig.passphrase = params.passphrase; } } else if (params.password) { connectConfig.password = params.password; } else { throw new McpError( ErrorCode.InvalidParams, 'Either password or privateKeyPath must be provided' ); } await ssh.connect(connectConfig); connectionPool.set(params.connectionId, ssh); // Initialize connection context connectionContexts.set(params.connectionId, { ssh, currentWorkingDirectory: undefined, defaultWorkingDirectory: undefined }); return { content: [ { type: 'text', text: `Successfully connected to ${params.host}:${params.port} as ${params.username} (Connection ID: ${params.connectionId})`, }, ], }; } catch (error) { throw new McpError( ErrorCode.InternalError, `SSH connection failed: ${error instanceof Error ? error.message : String(error)}` ); } }
- src/index.ts:60-68 (schema)Zod schema for input validation of ssh_connect tool parameters: host, port, username, optional password/privateKeyPath/passphrase, required connectionId.const ConnectSSHSchema = z.object({ host: z.string().describe('SSH server hostname or IP address'), port: z.number().default(22).describe('SSH port number'), username: z.string().describe('SSH username'), password: z.string().optional().describe('SSH password (if not using key)'), privateKeyPath: z.string().optional().describe('Path to private key file'), passphrase: z.string().optional().describe('Passphrase for private key'), connectionId: z.string().describe('Unique identifier for this connection') });
- src/index.ts:238-254 (registration)Tool registration in ListToolsRequestSchema handler, defining name 'ssh_connect', description, and JSON inputSchema matching the Zod schema.{ name: 'ssh_connect', description: 'Connect to an SSH server', inputSchema: { type: 'object', properties: { host: { type: 'string', description: 'SSH server hostname or IP address' }, port: { type: 'number', default: 22, description: 'SSH port number' }, username: { type: 'string', description: 'SSH username' }, password: { type: 'string', description: 'SSH password (if not using key)' }, privateKeyPath: { type: 'string', description: 'Path to private key file' }, passphrase: { type: 'string', description: 'Passphrase for private key' }, connectionId: { type: 'string', description: 'Unique identifier for this connection' } }, required: ['host', 'username', 'connectionId'] }, },
- src/index.ts:485-486 (registration)Dispatch in CallToolRequestSchema switch statement that routes 'ssh_connect' calls to the handleSSHConnect handler.case 'ssh_connect': return await this.handleSSHConnect(args);