mcp-use
Version:
Opinionated MCP Framework for TypeScript (@modelcontextprotocol/sdk compatible) - Build MCP Agents, Clients and Servers with support for ChatGPT Apps, Code Mode, OAuth, Notifications, Sampling, Observability and more.
30 lines • 1.89 kB
TypeScript
/**
* Widget mounting and serving utilities
*
* This module provides functions for mounting and serving MCP widgets in both
* development and production modes.
*/
import type { MCPServer } from "../mcp-server.js";
export { mountWidgetsDev, type MountWidgetsDevOptions, } from "./mount-widgets-dev.js";
export { mountWidgetsProduction, type MountWidgetsProductionOptions, } from "./mount-widgets-production.js";
export { setupWidgetRoutes } from "./setup-widget-routes.js";
export { createUIResourceFromDefinition, buildWidgetUrl, createExternalUrlResource, createRawHtmlResource, createRemoteDomResource, createAppsSdkResource, type UrlConfig, } from "./mcp-ui-adapter.js";
export { generateWidgetUri, convertPropsToInputs, applyDefaultProps, readBuildManifest, createWidgetUIResource, getContentType, processWidgetHtml, createWidgetRegistration, ensureWidgetMetadata, readWidgetHtml, registerWidgetFromTemplate, setupPublicRoutes, setupFaviconRoute, type WidgetServerConfig, } from "./widget-helpers.js";
export { uiResourceRegistration, type UIResourceServer, } from "./ui-resource-registration.js";
export { type ServerConfig, type MountWidgetsOptions, type RegisterWidgetCallback, } from "./widget-types.js";
/**
* Mount widget files - automatically chooses between dev and production mode
*
* In development mode: creates Vite dev servers with HMR support
* In production mode: serves pre-built static widgets
*
* @param options - Configuration options
* @param options.baseRoute - Base route for widgets (defaults to '/mcp-use/widgets')
* @param options.resourcesDir - Directory containing widget files (defaults to 'resources')
* @returns Promise that resolves when all widgets are mounted
*/
export declare function mountWidgets(server: MCPServer, options?: {
baseRoute?: string;
resourcesDir?: string;
}): Promise<void>;
//# sourceMappingURL=index.d.ts.map