refactor: rename uiOverrides to customUIs in ServerOptions and UIRegistry for clarity

Author: tsck

src/server.ts

@@ -63,20 +63,20 @@ export interface ServerOptions {
      */
     tools?: ToolClass[];
     /**
-     * Custom UI overrides for tools. Maps tool names to their HTML strings.
-     * These will override the default bundled UIs.
+     * Custom UIs for tools. Maps tool names to their HTML strings.
+     * Use this to add UIs to tools or replace the default bundled UIs.
      *
      * ```ts
      * import { readFileSync } from 'fs';
      * const server = new Server({
      *     // ... other options
-     *     uiOverrides: {
+     *     customUIs: {
      *         'list-databases': readFileSync('./my-custom-ui.html', 'utf-8'),
      *     }
      * });
      * ```
      */
-    uiOverrides?: Record<string, string>;
+    customUIs?: Record<string, string>;
 }
 
 export class Server {
@@ -107,7 +107,7 @@ export class Server {
         connectionErrorHandler,
         elicitation,
         tools,
-        uiOverrides,
+        customUIs,
     }: ServerOptions) {
         this.startTime = Date.now();
         this.session = session;
@@ -117,7 +117,7 @@ export class Server {
         this.elicitation = elicitation;
         this.connectionErrorHandler = connectionErrorHandler;
         this.toolConstructors = tools ?? AllTools;
-        this.uiRegistry = new UIRegistry({ overrides: uiOverrides });
+        this.uiRegistry = new UIRegistry({ customUIs });
     }
 
     async connect(transport: Transport): Promise<void> {

src/ui/registry/registry.ts

@@ -25,61 +25,61 @@ function getDefaultUIDistPath(): string {
  *
  * The registry:
  * - Loads default bundled HTML from dist/ui/ at runtime
- * - Allows overriding UIs via register()
+ * - Allows adding or replacing UIs via register()
  * - Provides get() to retrieve UI HTML for a tool
  */
 export class UIRegistry {
-    private overrides: Map<string, string> = new Map();
+    private customUIs: Map<string, string> = new Map();
     private cache: Map<string, string> = new Map();
     private uiDistPath: string;
 
-    constructor(options?: { uiDistPath?: string; overrides?: Record<string, string> }) {
+    constructor(options?: { uiDistPath?: string; customUIs?: Record<string, string> }) {
         // Use provided path or auto-detect the dist/ui location
         this.uiDistPath = options?.uiDistPath ?? getDefaultUIDistPath();
 
-        // Apply initial overrides if provided
-        if (options?.overrides) {
-            for (const [toolName, html] of Object.entries(options.overrides)) {
+        // Apply initial custom UIs if provided
+        if (options?.customUIs) {
+            for (const [toolName, html] of Object.entries(options.customUIs)) {
                 this.register(toolName, html);
             }
         }
     }
 
     /**
-     * Register a custom UI HTML string for a tool, overriding the default
+     * Register a custom UI HTML string for a tool
      * @param toolName The name of the tool (e.g., 'list-databases')
      * @param html The HTML string to use for this tool's UI
      */
     register(toolName: string, html: string): void {
-        this.overrides.set(toolName, html);
+        this.customUIs.set(toolName, html);
     }
 
     /**
-     * Unregister a custom UI for a tool, reverting to the default
+     * Unregister a custom UI for a tool, reverting to the default (if one exists)
      * @param toolName The name of the tool
      */
     unregister(toolName: string): void {
-        this.overrides.delete(toolName);
+        this.customUIs.delete(toolName);
     }
 
     /**
-     * Check if a tool has a UI registered (either override or default)
+     * Check if a tool has a UI registered (either custom or default)
      * @param toolName The name of the tool
      */
     has(toolName: string): boolean {
-        return this.overrides.has(toolName) || toolName in uiMap;
+        return this.customUIs.has(toolName) || toolName in uiMap;
     }
 
     /**
      * Get the UI HTML string for a tool
-     * Returns the override if registered, otherwise loads the default from disk
+     * Returns the custom UI if registered, otherwise loads the default from disk
      * @param toolName The name of the tool
      * @returns The HTML string, or undefined if no UI exists for this tool
      */
     get(toolName: string): string | undefined {
-        // Check for override first
-        if (this.overrides.has(toolName)) {
-            return this.overrides.get(toolName);
+        // Check for custom UI first
+        if (this.customUIs.has(toolName)) {
+            return this.customUIs.get(toolName);
         }
 
         // Check if we have a mapping for this tool
@@ -117,10 +117,10 @@ export class UIRegistry {
     }
 
     /**
-     * Get all registered tool names (both overrides and defaults)
+     * Get all registered tool names (both custom and default)
      */
     getRegisteredTools(): string[] {
-        const tools = new Set<string>([...this.overrides.keys(), ...Object.keys(uiMap)]);
+        const tools = new Set<string>([...this.customUIs.keys(), ...Object.keys(uiMap)]);
         return Array.from(tools);
     }
 }