Editor Scripting API
    Preparing search index...

    Class IMcpServer

    Plugin component interface for the editor MCP server, exposing connection details and runtime status.

        const { IMcpServer } = await import('LensStudio:Mcp');
        const server = this.pluginSystem.findInterface(IMcpServer) as IMcpServer;

        if (Editor.isNull(server)) {
          console.log('IMcpServer not available');
          return;
        }
        console.log(
          `IMcpServer: running=${server.isRunning()} url=${server.getServerUrl()}`,
        );

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    interfaceId

    Methods

    getConfig getServerToken getServerUrl getTypeName isOfType isRunning isSame

    Constructors

    Properties

    interfaceId: InterfaceId

    Interface identifier for resolving the MCP server component via the plugin system.

    Methods

    • Returns the current MCP server configuration object, or undefined if none is set.

      Returns any

    • Returns the authentication token clients use to connect to the MCP server.

      Returns string

    • Returns the URL where the MCP server is reachable.

      Returns string

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if the MCP server is currently running and accepting connections.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods