mcp-use TypeScript API
    Preparing search index...

    Interface StorageProvider

    Persists managed server configurations and optional presentation metadata.

    Implementations may be synchronous or asynchronous.

    interface StorageProvider {
        clear(): void | Promise<void>;
        getServerMetadata?(
            id: string,
        ):
            | CachedServerMetadata
            | Promise<CachedServerMetadata | undefined>
            | undefined;
        getServers(): | Record<string, PersistedMcpServerConfig>
        | Promise<Record<string, PersistedMcpServerConfig>>;
        removeServer(id: string): void | Promise<void>;
        removeServerMetadata?(id: string): void | Promise<void>;
        setServer(
            id: string,
            config: PersistedMcpServerConfig,
        ): void | Promise<void>;
        setServerMetadata?(
            id: string,
            metadata: CachedServerMetadata,
        ): void | Promise<void>;
        setServers(
            servers: Record<string, PersistedMcpServerConfig>,
        ): void | Promise<void>;
    }

    Implemented by

    Index
    clear getServerMetadata? getServers removeServer removeServerMetadata? setServer setServerMetadata? setServers

    • Removes all saved configurations and metadata.

      Returns void | Promise<void>

    • Removes one saved server configuration.

      Parameters

      • id: string

      Returns void | Promise<void>

    • Removes cached metadata for one server, when supported.

      Parameters

      • id: string

      Returns void | Promise<void>

    • Saves cached metadata for one server, when supported.

      Parameters

      Returns void | Promise<void>

    • Replaces all saved server configurations.

      Parameters

      Returns void | Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods