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

    Interface MCPFrontendService

    interface MCPFrontendService {
        addOrUpdateServer(description: MCPServerDescription): Promise<void>;
        getActiveServers(): Promise<string[]>;
        getPromptTemplateId(serverName: string): string;
        getServerDescription(
            name: string,
        ): Promise<undefined | MCPServerDescription>;
        getServerNames(): Promise<string[]>;
        getStartedServers(): Promise<string[]>;
        getTools(
            serverName: string,
        ): Promise<
            | undefined
            | {
                _meta?: {
                    "io.modelcontextprotocol/related-task"?: { taskId: string };
                    progressToken?: string | number;
                    [key: string]: unknown;
                };
                nextCursor?: string;
                tools: {
                    _meta?: { [key: string]: unknown };
                    annotations?: {
                        destructiveHint?: boolean;
                        idempotentHint?: boolean;
                        openWorldHint?: boolean;
                        readOnlyHint?: boolean;
                        title?: string;
                    };
                    description?: string;
                    execution?: { taskSupport?: "optional"
                    | "required"
                    | "forbidden" };
                    icons?: {
                        mimeType?: string;
                        sizes?: string[];
                        src: string;
                        theme?: "light" | "dark";
                    }[];
                    inputSchema: {
                        properties?: { [key: string]: object };
                        required?: string[];
                        type: "object";
                        [key: string]: unknown;
                    };
                    name: string;
                    outputSchema?: {
                        properties?: { [key: string]: object };
                        required?: string[];
                        type: "object";
                        [key: string]: unknown;
                    };
                    title?: string;
                }[];
                [key: string]: unknown;
            },
        >;
        hasServer(serverName: string): Promise<boolean>;
        hasStoredOAuthCredentials(serverName: string): Promise<boolean>;
        isServerStarted(serverName: string): Promise<boolean>;
        registerToolsForAllStartedServers(): Promise<void>;
        signIn(serverName: string): Promise<boolean>;
        signOut(serverName: string): Promise<void>;
        startServer(serverName: string): Promise<void>;
        startServerInteractive(serverName: string): Promise<boolean>;
        stopServer(serverName: string): Promise<void>;
    }

    Implemented by

    Index

    Methods

    addOrUpdateServer getActiveServers getPromptTemplateId getServerDescription getServerNames getStartedServers getTools hasServer hasStoredOAuthCredentials isServerStarted registerToolsForAllStartedServers signIn signOut startServer startServerInteractive stopServer

    Methods

    • Parameters

      • serverName: string

      Returns Promise<
          | undefined
          | {
              _meta?: {
                  "io.modelcontextprotocol/related-task"?: { taskId: string };
                  progressToken?: string | number;
                  [key: string]: unknown;
              };
              nextCursor?: string;
              tools: {
                  _meta?: { [key: string]: unknown };
                  annotations?: {
                      destructiveHint?: boolean;
                      idempotentHint?: boolean;
                      openWorldHint?: boolean;
                      readOnlyHint?: boolean;
                      title?: string;
                  };
                  description?: string;
                  execution?: { taskSupport?: "optional"
                  | "required"
                  | "forbidden" };
                  icons?: {
                      mimeType?: string;
                      sizes?: string[];
                      src: string;
                      theme?: "light" | "dark";
                  }[];
                  inputSchema: {
                      properties?: { [key: string]: object };
                      required?: string[];
                      type: "object";
                      [key: string]: unknown;
                  };
                  name: string;
                  outputSchema?: {
                      properties?: { [key: string]: object };
                      required?: string[];
                      type: "object";
                      [key: string]: unknown;
                  };
                  title?: string;
              }[];
              [key: string]: unknown;
          },
      >

    • Runs the OAuth sign-in flow for a remote OAuth server without leaving the server running. The obtained tokens stay in the credential store, so subsequent starts connect silently.

      Parameters

      • serverName: string

      Returns Promise<boolean>

      true when the sign-in completed; false when a pre-flight check failed (the pre-flight has already surfaced its own diagnostic) or the authorization handshake did not complete.

    • Starts a server initiated by a direct user action. Permits the OAuth flow to launch the user's default browser when authorization is required.

      Parameters

      • serverName: string

      Returns Promise<boolean>

      true when the start was attempted; false when a pre-flight check failed (the pre-flight has already surfaced its own diagnostic).

    Settings

    Member Visibility

    On This Page

    Methods