Frodo Library - v4.8.5
    Preparing search index...

    Type Alias McpToolRuntimeOptions

    Optional runtime customization hooks.

    type McpToolRuntimeOptions = {
        browserLoginPromptHandler?: BrowserLoginPromptHandler;
        configEntityHydrationStatus?: McpCatalogHydrationStatus;
        configEntityIds?: readonly string[];
        executeRecommendedByDefault?: boolean;
        frodoRoot?: Frodo;
        managedObjectHydrationStatus?: McpManagedObjectHydrationStatus;
        managedObjectTypes?: readonly string[];
        paginationWarningThreshold?: number;
        resolveFrodoForRequest?: (
            context: McpRuntimeRequestContext,
            frodoRoot: Frodo,
        ) => Frodo | Promise<Frodo>;
        resultWarningThresholdBytes?: number;
        trace?: McpToolRuntimeTraceHandler;
    }
    Index

    Properties

    browserLoginPromptHandler? configEntityHydrationStatus? configEntityIds? executeRecommendedByDefault? frodoRoot? managedObjectHydrationStatus? managedObjectTypes? paginationWarningThreshold? resolveFrodoForRequest? resultWarningThresholdBytes? trace?

    Properties

    browserLoginPromptHandler?: BrowserLoginPromptHandler

    Presents a browser-login (auth mode 'browser') interactive login step to whoever operates this MCP server. Required only for requests using that auth mode; every other mode ignores it. Frodo's MCP runtime never launches a browser or writes to stdout itself (stdio transport reserves stdout for the JSON-RPC stream) — the embedding host supplies this, typically printing to stderr and/or opening a local browser.

    configEntityHydrationStatus?: McpCatalogHydrationStatus

    Outcome of tenant config entity hydration.

    configEntityIds?: readonly string[]

    Tenant config entity IDs available to service-local semantic search.

    executeRecommendedByDefault?: boolean

    Execute unique deterministic read-only recommendations unless a request opts out.

    frodoRoot?: Frodo

    Optional root Frodo instance used by the default resolver. Defaults to the library singleton frodo.

    managedObjectHydrationStatus?: McpManagedObjectHydrationStatus

    Outcome of tenant managed-object type hydration.

    managedObjectTypes?: readonly string[]

    Tenant managed-object types available to service-local semantic search.

    paginationWarningThreshold?: number

    Optional heuristic threshold used to flag potentially paginated array responses when no explicit pagination controls were provided.

    Defaults to 1000.

    resolveFrodoForRequest?: (
        context: McpRuntimeRequestContext,
        frodoRoot: Frodo,
    ) => Frodo | Promise<Frodo>

    Optional custom resolver that returns a request-scoped Frodo instance. When omitted, resolveRequestScopedFrodo is used.

    resultWarningThresholdBytes?: number

    Optional payload size threshold used to flag large inline responses and produce actionable summary metadata for agents.

    Defaults to 65536 bytes.

    trace?: McpToolRuntimeTraceHandler

    Optional service-wide sink for payload-free lifecycle traces.

    Settings

    Member Visibility

    On This Page

    Properties