Class: WebSearchPlugin

AppKit plugin that resolves and holds the web-search runtime config used by the web_search / web_fetch tools.

Example

import { createApp, server } from "@databricks/appkit";
import { webSearch } from "@dbx-tools/appkit-web-search";

await createApp({
  plugins: [
    server(),
    webSearch({
      model: "gemini",
      urlPolicy: "allowlist",
      allowedUrls: ["*.databricks.com"],
    }),
  ],
});

Extends

ToolRegistryPlugin<WebSearchPluginConfig>

Constructors

Constructor

new WebSearchPlugin(config): WebSearchPlugin

Parameters

config

WebSearchPluginConfig

Returns

WebSearchPlugin

Inherited from

ToolRegistryPlugin<WebSearchPluginConfig>.constructor

Properties

app

protected app: AppManager

Inherited from

ToolRegistryPlugin.app

cache

protected cache: CacheManager

Inherited from

ToolRegistryPlugin.cache

config

protected config: WebSearchPluginConfig

Inherited from

ToolRegistryPlugin.config

context?

protected optional context?: PluginContext

Inherited from

ToolRegistryPlugin.context

devFileReader

protected devFileReader: DevFileReader

Inherited from

ToolRegistryPlugin.devFileReader

isReady

protected isReady: boolean

Inherited from

ToolRegistryPlugin.isReady

name

name: string

Plugin name identifier.

Inherited from

ToolRegistryPlugin.name

streamManager

protected streamManager: StreamManager

Inherited from

ToolRegistryPlugin.streamManager

telemetry

protected telemetry: ITelemetry

Inherited from

ToolRegistryPlugin.telemetry

toolRegistry

protected readonly toolRegistry: ToolRegistry

The tools this plugin offers to an AppKit agent. Both are reads and both run under the caller’s identity.

Neither is autoInheritable. web_fetch reaches a URL the model chose, which is reachable from inside the workspace network, so it must only appear in an agent that asked for it and accepted the URL policy that comes with it. web_search is safer but still spends serving tokens on every call, so it is opt-in for cost rather than for safety.

execute re-parses its arguments with the local schema: AppKit validates against the same schema first, but re-parsing is what gives the body typed arguments instead of unknown.

Overrides

ToolRegistryPlugin.toolRegistry

manifest

static manifest: object

config

config: object

config.schema

schema: JSONSchema7 = WEB_SEARCH_CONFIG_SCHEMA

description

description: string

displayName

displayName: string = "Web Search"

name

name: "web-search" = "web-search"

resources

resources: object

resources.optional

optional: object[]

resources.required

required: never[] = []

stability

stability: "beta" = "beta"

phase

static phase: PluginPhase

Plugin initialization phase.

‘core’: Initialized first (e.g., config plugins)
‘normal’: Initialized second (most plugins)
‘deferred’: Initialized last (e.g., server plugin)

Inherited from

ToolRegistryPlugin.phase

Methods

abortActiveOperations()

abortActiveOperations(): void

Abort in-flight work owned by this plugin instance.

Returns

void

Overrides

ToolRegistryPlugin.abortActiveOperations

asUser()

asUser(req): this

Execute operations using the user’s identity from the request. Returns a proxy of this plugin where all method calls execute with the user’s Databricks credentials instead of the service principal.

Parameters

req

Request

The Express request containing the user token in headers

Returns

this

A proxied plugin instance that executes as the user

Throws

AuthenticationError if user token is not available in request headers (production only). In development mode (NODE_ENV=development), skips user impersonation instead of throwing.

Inherited from

ToolRegistryPlugin.asUser

attachContext()

attachContext(deps?): void

Binds runtime dependencies (telemetry provider, cache, plugin context) to this plugin. Called by AppKit._createApp after construction and before setup(). Idempotent: safe to call if the constructor already bound them eagerly. Kept separate so factories can eagerly construct plugin instances without running this before TelemetryManager.initialize() / CacheManager.getInstance() have run.

Parameters

deps?

context?

unknown

telemetryConfig?

TelemetryOptions

Returns

void

Inherited from

ToolRegistryPlugin.attachContext

clientConfig()

clientConfig(): Record<string, unknown>

Returns startup config to expose to the client. Override this to surface server-side values that are safe to publish to the frontend, such as feature flags, resource IDs, or other app boot settings.

This runs once when the server starts, so it should not depend on request-scoped or user-specific state.

String values that match non-public environment variables are redacted unless you intentionally expose them via a matching PUBLIC_APPKIT_ env var.

Values must be JSON-serializable plain data (no functions, Dates, classes, Maps, Sets, BigInts, or circular references). By default returns an empty object (plugin contributes nothing to client config).

On the client, read the config with the usePluginClientConfig hook (React) or the getPluginClientConfig function (vanilla JS), both from @databricks/appkit-ui.

Returns

Record<string, unknown>

Example

// Server — plugin definition
class MyPlugin extends Plugin<MyConfig> {
  clientConfig() {
    return {
      warehouseId: this.config.warehouseId,
      features: { darkMode: true },
    };
  }
}

// Client — React component
import { usePluginClientConfig } from "@databricks/appkit-ui/react";

interface MyPluginConfig { warehouseId: string; features: { darkMode: boolean } }

const config = usePluginClientConfig<MyPluginConfig>("myPlugin");
config.warehouseId; // "abc-123"

// Client — vanilla JS
import { getPluginClientConfig } from "@databricks/appkit-ui/js";

const config = getPluginClientConfig<MyPluginConfig>("myPlugin");

Inherited from

ToolRegistryPlugin.clientConfig

execute()

protected execute<T>(fn, options, userKey?): Promise<ExecutionResult<T>>

Execute a function with the plugin’s interceptor chain.

Returns an ExecutionResult discriminated union:

{ ok: true, data: T } on success
{ ok: false, status: number, message: string } on failure

Errors are never thrown — the method is production-safe.

Type Parameters

T

T

Parameters

fn

(signal?) => Promise<T>

options

PluginExecutionSettings

userKey?

string

Returns

Promise<ExecutionResult<T>>

Inherited from

ToolRegistryPlugin.execute

executeAgentTool()

executeAgentTool(name, args, signal?, context?): Promise<unknown>

Dispatch with the actual calling model and optional host progress sink.

Parameters

name

string

args

unknown

signal?

AbortSignal

context?

AgentToolExecutionContext

Returns

Promise<unknown>

Overrides

ToolRegistryPlugin.executeAgentTool

executeStream()

protected executeStream<T>(res, fn, options, userKey?): Promise<void>

Type Parameters

T

T

Parameters

res

IAppResponse

fn

StreamExecuteHandler<T>

options

StreamExecutionSettings

userKey?

string

Returns

Promise<void>

Inherited from

ToolRegistryPlugin.executeStream

exports()

exports(): object

Returns the public exports for this plugin. Override this to define a custom public API. By default, returns an empty object.

The returned object becomes the plugin’s public API on the AppKit instance (e.g. appkit.myPlugin.method()). AppKit automatically binds method context and adds asUser(req) for user-scoped execution.

Returns

fetch

fetch: (request, signal?) => Promise<{ content: string; contentType?: string; status: number; title?: string; truncated: boolean; url: string; }>

Fetch one URL directly (bypassing the agent tool). Enforces the configured URL policy.

Parameters

request

format?

"text" | "html" = ...

maxLength?

number = ...

url

string = ...

signal?

AbortSignal

Returns

Promise<{ content: string; contentType?: string; status: number; title?: string; truncated: boolean; url: string; }>

search

search: (request, signal?) => Promise<{ answer: string; citations: object[]; model: string; query: string; }>

Run a web search directly (bypassing the agent tool). Resolves the OBO client from the active execution context and reads this plugin’s runtime config.

Parameters

request

model?

string = ...

query

string = ...

signal?

AbortSignal

Returns

Promise<{ answer: string; citations: object[]; model: string; query: string; }>

Example

class MyPlugin extends Plugin {
  private getData() { return []; }

  exports() {
    return { getData: this.getData };
  }
}

// After registration:
const appkit = await createApp({ plugins: [myPlugin()] });
appkit.myPlugin.getData();

Overrides

ToolRegistryPlugin.exports

getAgentTools()

getAgentTools(): AgentToolDefinition[]

Tool definitions offered to an AppKit agent.

Returns

AgentToolDefinition[]

Inherited from

ToolRegistryPlugin.getAgentTools

getEndpoints()

getEndpoints(): PluginEndpointMap

Returns

PluginEndpointMap

Inherited from

ToolRegistryPlugin.getEndpoints

getSkipBodyParsingPaths()

getSkipBodyParsingPaths(): ReadonlySet<string>

Returns

ReadonlySet<string>

Inherited from

ToolRegistryPlugin.getSkipBodyParsingPaths

injectRoutes()

injectRoutes(_): void

Parameters

_

Router

Returns

void

Inherited from

ToolRegistryPlugin.injectRoutes

registerEndpoint()

protected registerEndpoint(name, path): void

Parameters

name

string

path

string

Returns

void

Inherited from

ToolRegistryPlugin.registerEndpoint

resolveUserId()

protected resolveUserId(req): string

Resolve the effective user ID from a request.

Returns the x-forwarded-user header when present. In development mode (NODE_ENV=development) falls back to the current context user ID so that callers outside an active runInUserContext scope still get a consistent value.

Parameters

req

Request

Returns

string

Throws

AuthenticationError in production when no user header is present.

Inherited from

ToolRegistryPlugin.resolveUserId

route()

protected route<_TResponse>(router, config): void

Type Parameters

_TResponse

_TResponse

Parameters

router

Router

config

RouteConfig

Returns

void

Inherited from

ToolRegistryPlugin.route

setup()

setup(): Promise<void>

Log the effective policy so an active allow-list and caps are obvious at boot. Runtime construction already resolved config and captured this plugin’s interceptor chain.

Returns

Promise<void>

Overrides

ToolRegistryPlugin.setup

shutdown()

shutdown(): void

No runtime resources require draining. The instance-owned config and executor become unreachable with this plugin.

Returns

void

getResourceRequirements()

static getResourceRequirements(config): ResourceRequirement[]

Promote the serving endpoint to a required resource once a deployment pins one, through plugin config or either environment name. Left optional otherwise, because the plugin picks a web-search-capable endpoint out of the live catalogue on its own.

Parameters

config

WebSearchPluginConfig

Returns

ResourceRequirement[]