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

    Class MCPFrontendServiceImpl

    Implements

    Index

    Constructors

    constructor

    Properties

    logger mcpServerManager messageService promptService toolInvocationRegistry workspaceTrustService

    Methods

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

    Constructors

    Properties

    logger: ILogger
    mcpServerManager: MCPServerManager
    messageService: MessageService
    promptService: PromptService
    toolInvocationRegistry: ToolInvocationRegistry
    workspaceTrustService: WorkspaceTrustService

    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

    Constructors
    Properties
    Methods