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

    Interface LocalMCPServerDescription

    interface LocalMCPServerDescription {
        args?: string[];
        autostart?: boolean;
        command: string;
        deferLoading?: boolean;
        env?: { [key: string]: string };
        error?: string;
        name: string;
        registryMetadata?: MCPRegistryMetadata;
        resolve?: (
            description: MCPServerDescription,
        ) => Promise<undefined | MCPServerDescription>;
        status?: MCPServerStatus;
        tools?: ToolInformation[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    args? autostart? command deferLoading? env? error? name registryMetadata? resolve? status? tools?

    Properties

    args?: string[]

    Arguments for the MCP server command.

    autostart?: boolean

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

    command: string

    The command to start the MCP server.

    deferLoading?: boolean

    If true, all tools provided by this server are marked as deferred in the generated prompt fragment (mcp_<name>_tools). Deferred tools are not loaded into the model's context upfront and may instead be discovered on-demand via the model provider's built-in tool search mechanism (Anthropic, OpenAI) when supported by the provider. Individual tools may still be referenced explicitly without the deferred marker.

    env?: { [key: string]: string }

    Environment variables for the MCP server process.

    error?: string

    Last error message that the server has returned.

    name: string

    The unique name of the MCP server.

    registryMetadata?: MCPRegistryMetadata

    If set, provenance metadata for a server installed from an AI registry. Written by @theia/ai-registry on install / link / fix / update; not user-editable.

    resolve?: (
        description: MCPServerDescription,
    ) => Promise<undefined | MCPServerDescription>

    Optional resolve function that gets called during server definition resolution.

    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