agentic-openapi-parser
    Preparing search index...

    Interface ExecuteToolOptions

    interface ExecuteToolOptions {
        accessToken?: string;
        accessTokenProvider?: AccessTokenProvider;
        authType?: DynamicProviderAuthType;
        hooks?: ObservabilityHooks;
        namespace?: string;
        oauth2State?: OAuth2TokenState;
        responseProcessors?: ResponseProcessor[];
        retry?: RetryOptions;
        signal?: AbortSignal;
        timeout?: number;
        tokenRefresher?: TokenRefresher;
    }
    Index
    accessToken? accessTokenProvider? authType? hooks? namespace? oauth2State? responseProcessors? retry? signal? timeout? tokenRefresher?
    accessToken?: string
    accessTokenProvider?: AccessTokenProvider

    Supplies the access token from scratch (e.g. OAuth2 client_credentials). Takes precedence over tokenRefresher/oauth2State when both are set — the two model different grant types and aren't meant to be combined.

    authType?: DynamicProviderAuthType
    hooks?: ObservabilityHooks

    Synchronous callbacks for wiring into an APM/tracing tool of the caller's choice. A throwing hook is caught and logged — it never fails the tool call.

    namespace?: string

    Must match the namespace passed to parseAndFlatten() for this tool, so its name can be resolved back to the OpenAPI operation.

    oauth2State?: OAuth2TokenState
    responseProcessors?: ResponseProcessor[]
    retry?: RetryOptions
    signal?: AbortSignal

    Lets the caller cancel an in-flight tool call (e.g. a user-initiated "Stop") — aborts the underlying HTTP request immediately instead of waiting for it to finish or time out, and skips any further retry attempts.

    timeout?: number
    tokenRefresher?: TokenRefresher

    Settings
    Member Visibility

    On This Page
    Properties