ssh-mcp-pro API - v1.1.2
    Preparing search index...

    Interface ServerConfig

    Server configuration options

    interface ServerConfig {
        auth: {
            mode: "bearer" | "oauth";
            oauthAudience?: string;
            oauthIssuer?: string;
            oauthJwksUrl?: string;
            oauthRequiredScopes: string[];
            oauthResource?: string;
        };
        cleanupIntervalMs: number;
        commandTimeoutMs: number;
        connector: {
            credentialCommand?: string;
            credentialCommandArgs: string[];
            credentialCommandTimeoutMs: number;
            credentialProvider: "none"
            | "command"
            | "agent";
            defaultUsername?: string;
            toolProfile:
                | "full"
                | "remote-safe"
                | "chatgpt"
                | "claude"
                | "remote-readonly"
                | "remote-broker";
        };
        debug: boolean;
        http: {
            allowedOrigins: string[];
            bearerTokenFile?: string;
            enableLegacySse: boolean;
            host: string;
            maxRequestBodyBytes: number;
            maxSessions: number;
            port: number;
            publicUrl?: string;
            sessionIdleTtlMs: number;
            trustProxy: boolean;
        };
        maxCommandOutputBytes: number;
        maxFileSize: number;
        maxFileWriteBytes: number;
        maxSessions: number;
        maxStreamChunks: number;
        maxTransferBytes: number;
        policy: PolicyConfig;
        rateLimit: {
            enabled: boolean;
            maxRequests: number;
            perSession: { enabled: boolean; maxRequests: number; windowMs: number };
            windowMs: number;
        };
        security: {
            allowedCiphers: string[];
            allowRootLogin: boolean;
            hostKeyPolicy: HostKeyPolicy;
            knownHostsPath: string;
        };
        sessionTtlMs: number;
    }
    Index

    Properties

    auth cleanupIntervalMs commandTimeoutMs connector debug http maxCommandOutputBytes maxFileSize maxFileWriteBytes maxSessions maxStreamChunks maxTransferBytes policy rateLimit security sessionTtlMs

    Properties

    auth: {
        mode: "bearer" | "oauth";
        oauthAudience?: string;
        oauthIssuer?: string;
        oauthJwksUrl?: string;
        oauthRequiredScopes: string[];
        oauthResource?: string;
    }

    HTTP authorization settings for remote MCP clients

    cleanupIntervalMs: number

    Session cleanup interval in milliseconds

    commandTimeoutMs: number

    Default command timeout in milliseconds

    connector: {
        credentialCommand?: string;
        credentialCommandArgs: string[];
        credentialCommandTimeoutMs: number;
        credentialProvider: "none" | "command" | "agent";
        defaultUsername?: string;
        toolProfile:
            | "full"
            | "remote-safe"
            | "chatgpt"
            | "claude"
            | "remote-readonly"
            | "remote-broker";
    }

    Remote ChatGPT/Claude connector settings

    debug: boolean

    Enable debug logging

    http: {
        allowedOrigins: string[];
        bearerTokenFile?: string;
        enableLegacySse: boolean;
        host: string;
        maxRequestBodyBytes: number;
        maxSessions: number;
        port: number;
        publicUrl?: string;
        sessionIdleTtlMs: number;
        trustProxy: boolean;
    }

    Remote HTTP transport settings

    maxCommandOutputBytes: number

    Maximum buffered stdout/stderr per command result (bytes)

    maxFileSize: number

    Maximum file size for read operations (bytes)

    maxFileWriteBytes: number

    Maximum file write payload size accepted before buffering (bytes)

    maxSessions: number

    Maximum concurrent sessions

    maxStreamChunks: number

    Maximum streaming chunks retained in memory

    maxTransferBytes: number

    Maximum file transfer size (bytes)

    policy: PolicyConfig

    Policy settings enforced before risky operations

    rateLimit: {
        enabled: boolean;
        maxRequests: number;
        perSession: { enabled: boolean; maxRequests: number; windowMs: number };
        windowMs: number;
    }

    Rate limiting configuration

    security: {
        allowedCiphers: string[];
        allowRootLogin: boolean;
        hostKeyPolicy: HostKeyPolicy;
        knownHostsPath: string;
    }

    Security settings

    sessionTtlMs: number

    Default session TTL in milliseconds

    Settings

    Member Visibility

    On This Page

    Properties