Theia API Documentation v1.66.0
    Preparing search index...

    Interface RemoteMCPServerDescription

    interface RemoteMCPServerDescription {
        autostart?: boolean;
        error?: string;
        headers?: Record<string, string>;
        name: string;
        resolve?: (
            description: MCPServerDescription,
        ) => Promise<MCPServerDescription>;
        serverAuthToken?: string;
        serverAuthTokenHeader?: string;
        serverUrl: string;
        status?: MCPServerStatus;
        tools?: ToolInformation[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    autostart? error? headers? name resolve? serverAuthToken? serverAuthTokenHeader? serverUrl status? tools?

    Properties

    autostart?: boolean

    Flag indicating whether the server should automatically start when the application starts.

    error?: string

    Last error message that the server has returned.

    headers?: Record<string, string>

    Optional additional headers to include in requests to the server.

    name: string

    The unique name of the MCP server.

    resolve?: (description: MCPServerDescription) => Promise<MCPServerDescription>

    Optional resolve function that gets called during server definition resolution. This function can be used to dynamically modify server configurations, resolve environment variables, validate configurations, or perform any necessary preprocessing before the server starts.

    Type Declaration

    serverAuthToken?: string

    The authentication token for the server, if required.

    serverAuthTokenHeader?: string

    The header name to use for the server authentication token.

    serverUrl: string

    The URL of the remote MCP server.

    status?: MCPServerStatus

    The current status of the server. Optional because only set by the server.

    tools?: ToolInformation[]

    List of available tools for the server. Returns the name and description if available.

    Settings

    Member Visibility

    On This Page

    Properties