/**
* Widget registry for MCP server UI widgets
*
* This module manages widget configuration and validates that widget files exist
* at runtime.
*/
const OPENAI_WIDGET_CSP = {
connect_domains: ['https://api.apify.com'],
resource_domains: [
'https://mcp.apify.com',
'https://images.apifyusercontent.com',
],
} as const;
const OPENAI_WIDGET_BASE_META = {
'openai/widgetAccessible': true,
'openai/resultCanProduceWidget': true,
'openai/widgetPrefersBorder': true,
'openai/widgetDomain': 'https://apify.com',
'openai/widgetCSP': OPENAI_WIDGET_CSP,
} as const;
export const WIDGET_URIS = {
SEARCH_ACTORS: 'ui://widget/search-actors.html',
ACTOR_RUN: 'ui://widget/actor-run.html',
} as const;
export type WidgetConfig = {
uri: string;
name: string;
description: string;
jsFilename: string;
title: string;
meta: {
'openai/outputTemplate': string;
'openai/toolInvocation/invoking'?: string;
'openai/toolInvocation/invoked'?: string;
'openai/widgetAccessible': boolean;
'openai/resultCanProduceWidget': boolean;
'openai/widgetDomain': string;
'openai/widgetCSP': {
readonly connect_domains: readonly string[];
readonly resource_domains: readonly string[];
};
};
};
/**
* Widget registry configuration
* Maps widget URIs to their configuration
*/
export const WIDGET_REGISTRY: Record<string, WidgetConfig> = {
[WIDGET_URIS.SEARCH_ACTORS]: {
uri: WIDGET_URIS.SEARCH_ACTORS,
name: 'search-actors-widget',
description: 'Interactive Actor search results widget',
jsFilename: 'search-actors-widget.js',
title: 'Apify Actor Search',
meta: {
...OPENAI_WIDGET_BASE_META,
'openai/outputTemplate': WIDGET_URIS.SEARCH_ACTORS,
'openai/toolInvocation/invoking': 'Searching Apify Store...',
'openai/toolInvocation/invoked': 'Found Actors matching your criteria',
},
},
[WIDGET_URIS.ACTOR_RUN]: {
uri: WIDGET_URIS.ACTOR_RUN,
name: 'actor-run-widget',
description: 'Interactive Actor run widget',
jsFilename: 'actor-run-widget.js',
title: 'Apify Actor Run',
meta: {
...OPENAI_WIDGET_BASE_META,
'openai/outputTemplate': WIDGET_URIS.ACTOR_RUN,
'openai/toolInvocation/invoking': 'Running Apify Actor...',
'openai/toolInvocation/invoked': 'Actor run started',
},
},
};
export type AvailableWidget = WidgetConfig & {
jsPath: string;
exists: boolean;
};
/**
* Resolves available widgets by checking if their files exist on the filesystem.
*
* @param baseDir - Base directory where the server code is located
* @returns Map of widget URIs to their resolved state
*/
export async function resolveAvailableWidgets(baseDir: string): Promise<Map<string, AvailableWidget>> {
const fs = await import('node:fs');
const path = await import('node:path');
const resolvedWidgets = new Map<string, AvailableWidget>();
const webDistPath = path.resolve(baseDir, '../web/dist');
for (const [uri, config] of Object.entries(WIDGET_REGISTRY)) {
const jsPath = path.resolve(webDistPath, config.jsFilename);
const exists = fs.existsSync(jsPath);
resolvedWidgets.set(uri, {
...config,
jsPath,
exists,
});
}
return resolvedWidgets;
}
/**
* Get widget configuration by URI
*
* @param uri - Widget URI
* @returns Widget configuration or undefined if not found
*/
export function getWidgetConfig(uri: string): WidgetConfig | undefined {
return WIDGET_REGISTRY[uri];
}
