@dynamicu/chromedebug-mcp 2.2.0

package/src/mcp/tools/index.js

@@ -0,0 +1,701 @@
+/**
+ * Tool Registry module for managing MCP tools
+ * Provides centralized tool definition and lazy loading capabilities
+ */
+
+// Tool definitions - extracted from original index.js
+const toolDefinitions = [
+  {
+    name: 'launch_chrome',
+    description: 'Launch a Chrome browser instance for this MCP server',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'connect_to_existing_chrome',
+    description: 'Connect to an existing Chrome instance with debugging enabled',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        port: {
+          type: 'number',
+          description: 'Debugging port Chrome is running on (default: 9222)',
+          default: 9222,
+        },
+      },
+    },
+  },
+  {
+    name: 'navigate_to',
+    description: 'Navigate to a URL',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        url: {
+          type: 'string',
+          description: 'URL to navigate to',
+        },
+      },
+      required: ['url'],
+    },
+  },
+  {
+    name: 'pause_execution',
+    description: 'Pause Chrome execution',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'resume_execution',
+    description: 'Resume Chrome execution',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'step_over',
+    description: 'Step over in Chrome debugger',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'evaluate_expression',
+    description: 'Evaluate a JavaScript expression in Chrome',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        expression: {
+          type: 'string',
+          description: 'JavaScript expression to evaluate',
+        },
+      },
+      required: ['expression'],
+    },
+  },
+  {
+    name: 'get_scopes',
+    description: 'Get scope variables from the top call frame',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'set_breakpoint',
+    description: 'Set a breakpoint at a specific URL and line',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        url: {
+          type: 'string',
+          description: 'URL of the script',
+        },
+        lineNumber: {
+          type: 'number',
+          description: 'Line number for the breakpoint',
+        },
+      },
+      required: ['url', 'lineNumber'],
+    },
+  },
+  {
+    name: 'get_logs',
+    description: 'Get recent console logs',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'check_connection',
+    description: 'Check if Chrome is connected',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'force_reset',
+    description: 'Force reset Chrome by killing all processes and clearing state',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'take_screenshot',
+    description: 'Take a screenshot optimized for AI processing',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        fullPage: {
+          type: 'boolean',
+          description: 'Capture full page (default: true, but limited to 600px height for AI)',
+        },
+        lowRes: {
+          type: 'boolean',
+          description: 'Low-resolution mode for AI (default: true)',
+        },
+        quality: {
+          type: 'number',
+          description: 'JPEG quality (1-100, default: 30)',
+          minimum: 1,
+          maximum: 100,
+        },
+        type: {
+          type: 'string',
+          description: 'Image type (default: jpeg)',
+          enum: ['png', 'jpeg'],
+        },
+        path: {
+          type: 'string',
+          description: 'Save screenshot to file path',
+        },
+      },
+    },
+  },
+  {
+    name: 'get_page_content',
+    description: 'Get the content of the current page including text, HTML, and DOM structure. Useful for checking if specific content exists without taking a screenshot.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        includeText: {
+          type: 'boolean',
+          description: 'Include extracted text content (default: true)',
+        },
+        includeHtml: {
+          type: 'boolean',
+          description: 'Include full HTML source (default: false, can be large)',
+        },
+        includeStructure: {
+          type: 'boolean',
+          description: 'Include DOM structure with important elements and attributes (default: true)',
+        },
+      },
+    },
+  },
+  {
+    name: 'get_selected_element',
+    description: 'Get information about the currently selected element from Chrome extension',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'apply_css_to_selected',
+    description: 'Apply CSS styles to the currently selected element',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        css: {
+          type: 'string',
+          description: 'CSS rules to apply',
+        },
+      },
+      required: ['css'],
+    },
+  },
+  {
+    name: 'execute_js_on_selected',
+    description: 'Execute JavaScript code on the currently selected element',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        code: {
+          type: 'string',
+          description: 'JavaScript code to execute. The element is available as the "element" variable.',
+        },
+      },
+      required: ['code'],
+    },
+  },
+  {
+    name: 'clear_selected_element',
+    description: 'Clear the currently selected element',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'get_websocket_info',
+    description: 'Get WebSocket server information for Chrome extension',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'get_workflow_recording',
+    description: 'Get a complete workflow recording including actions and optional logs',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The workflow session ID',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'list_workflow_recordings',
+    description: 'List all workflow recordings stored in the database',
+    inputSchema: {
+      type: 'object',
+      properties: {},
+    },
+  },
+  {
+    name: 'get_workflow_function_traces',
+    description: 'Get only function execution traces from a workflow recording',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The workflow session ID',
+        },
+        includeStack: {
+          type: 'boolean',
+          description: 'Include stack traces (default: false)',
+        },
+        limit: {
+          type: 'number',
+          description: 'Maximum number of traces to return',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'get_workflow_errors',
+    description: 'Get only error logs and error-related actions from a workflow',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The workflow session ID',
+        },
+        includeWarnings: {
+          type: 'boolean',
+          description: 'Include warning logs (default: false)',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'get_workflow_summary',
+    description: 'Get a concise summary of a workflow recording',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The workflow session ID',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'get_workflow_actions_filtered',
+    description: 'Get filtered workflow actions by type or time range',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The workflow session ID',
+        },
+        actionTypes: {
+          type: 'array',
+          items: { type: 'string' },
+          description: 'Filter by action types (e.g., ["click", "input", "function-trace"])',
+        },
+        startIndex: {
+          type: 'number',
+          description: 'Start index for pagination',
+        },
+        limit: {
+          type: 'number',
+          description: 'Maximum number of actions to return',
+        },
+        includeDetails: {
+          type: 'boolean',
+          description: 'Include full action details (default: false)',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'save_restore_point',
+    description: 'Save a restore point for the current browser state including DOM, form values, storage, and cookies',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        workflowId: {
+          type: 'string',
+          description: 'The workflow ID this restore point belongs to',
+        },
+        actionIndex: {
+          type: 'number',
+          description: 'The action index in the workflow where this restore point was created',
+        },
+        description: {
+          type: 'string',
+          description: 'Optional description of this restore point',
+        },
+      },
+      required: ['workflowId'],
+    },
+  },
+  {
+    name: 'restore_from_point',
+    description: 'Restore the browser to a previously saved restore point',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        restorePointId: {
+          type: 'string',
+          description: 'The ID of the restore point to restore from',
+        },
+      },
+      required: ['restorePointId'],
+    },
+  },
+  {
+    name: 'list_restore_points',
+    description: 'List all restore points for a workflow',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        workflowId: {
+          type: 'string',
+          description: 'The workflow ID to get restore points for',
+        },
+      },
+      required: ['workflowId'],
+    },
+  },
+  {
+    name: 'chromedebug_show_frames',
+    description: 'Display frame recording information in a compact format optimized for MCP tools. Shows frame metadata, console logs, and timestamps without including large image data.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The frame session ID to display',
+        },
+        maxFrames: {
+          type: 'number',
+          description: 'Maximum number of frames to display (default: 10)',
+          default: 10,
+        },
+        showLogs: {
+          type: 'boolean',
+          description: 'Whether to show console logs for each frame (default: true)',
+          default: true,
+        },
+        showInteractions: {
+          type: 'boolean',
+          description: 'Whether to show user interactions for each frame (default: true)',
+          default: true,
+        },
+        logLevel: {
+          type: 'string',
+          description: 'Filter logs by level: error, warn, info, debug, log, or all (default: all)',
+          enum: ['error', 'warn', 'info', 'debug', 'log', 'all'],
+          default: 'all',
+        },
+        maxLogsPerFrame: {
+          type: 'number',
+          description: 'Maximum number of logs to show per frame (default: 10). Use 0 for no limit.',
+          default: 10,
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'get_frame_session_info',
+    description: 'Get information about a frame capture session including total frames and timestamps',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The frame session ID returned when recording was saved',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'get_screen_interactions',
+    description: 'Get all user interactions (clicks, inputs, keypresses, scrolls) recorded during a screen recording session',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The screen recording session ID',
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'get_frame',
+    description: 'Get a specific frame from a frame capture session',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The frame session ID',
+        },
+        frameIndex: {
+          type: 'number',
+          description: 'The frame index to retrieve (0-based)',
+        },
+        maxLogs: {
+          type: 'number',
+          description: 'Maximum number of logs to show (default: 20). Use 0 for no limit.',
+          default: 20,
+        },
+        logLevel: {
+          type: 'string',
+          description: 'Filter logs by level: error, warn, info, debug, log, or all (default: all)',
+          enum: ['error', 'warn', 'info', 'debug', 'log', 'all'],
+          default: 'all',
+        },
+        searchLogs: {
+          type: 'string',
+          description: 'Search for specific text in log messages (case insensitive)',
+        },
+      },
+      required: ['sessionId', 'frameIndex'],
+    },
+  },
+  {
+    name: 'search_frame_logs',
+    description: 'Search for specific logs across all frames in a recording session',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The frame session ID to search',
+        },
+        searchText: {
+          type: 'string',
+          description: 'Text to search for in log messages (case insensitive)',
+        },
+        logLevel: {
+          type: 'string',
+          description: 'Filter by log level: error, warn, info, debug, log, or all (default: all)',
+          enum: ['error', 'warn', 'info', 'debug', 'log', 'all'],
+          default: 'all',
+        },
+        maxResults: {
+          type: 'number',
+          description: 'Maximum number of matching logs to return (default: 50)',
+          default: 50,
+        },
+      },
+      required: ['sessionId', 'searchText'],
+    },
+  },
+  {
+    name: 'get_frame_logs_paginated',
+    description: 'Get logs for a specific frame with pagination to handle large log volumes',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The frame session ID',
+        },
+        frameIndex: {
+          type: 'number',
+          description: 'The frame index to retrieve logs from (0-based)',
+        },
+        offset: {
+          type: 'number',
+          description: 'Number of logs to skip (for pagination, default: 0)',
+          default: 0,
+        },
+        limit: {
+          type: 'number',
+          description: 'Maximum number of logs to return (default: 100)',
+          default: 100,
+        },
+        logLevel: {
+          type: 'string',
+          description: 'Filter by log level: error, warn, info, debug, log, or all (default: all)',
+          enum: ['error', 'warn', 'info', 'debug', 'log', 'all'],
+          default: 'all',
+        },
+        searchText: {
+          type: 'string',
+          description: 'Search for specific text in log messages (case insensitive)',
+        },
+      },
+      required: ['sessionId', 'frameIndex'],
+    },
+  },
+  {
+    name: 'get_frame_screenshot',
+    description: 'Get the screenshot image data for a specific frame as base64 encoded string. This allows viewing of the actual screenshots captured during frame recordings.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The frame session ID',
+        },
+        frameIndex: {
+          type: 'number',
+          description: 'The frame index to retrieve screenshot from (0-based)',
+        },
+        includeMetadata: {
+          type: 'boolean',
+          description: 'Include image metadata like size and format (default: false)',
+          default: false,
+        },
+      },
+      required: ['sessionId', 'frameIndex'],
+    },
+  },
+  {
+    name: 'play_workflow_recording',
+    description: 'Play a workflow recording by executing all recorded actions',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        sessionId: {
+          type: 'string',
+          description: 'The workflow session ID to play',
+        },
+        speed: {
+          type: 'number',
+          description: 'Playback speed multiplier (1 = normal, 2 = 2x faster, 0.5 = half speed)',
+          default: 1,
+        },
+      },
+      required: ['sessionId'],
+    },
+  },
+  {
+    name: 'play_workflow_by_name',
+    description: 'Play a workflow recording by its name',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        name: {
+          type: 'string',
+          description: 'The name of the workflow recording to play',
+        },
+        speed: {
+          type: 'number',
+          description: 'Playback speed multiplier (1 = normal, 2 = 2x faster, 0.5 = half speed)',
+          default: 1,
+        },
+      },
+      required: ['name'],
+    },
+  },
+  /*
+   * SNAPSHOT FEATURE DISABLED (2025-10-01)
+   *
+   * Snapshot MCP tools removed - see SNAPSHOT_FEATURE_DISABLED.md
+   *
+   * Removed tools:
+   * - take_snapshot
+   * - list_snapshots
+   * - get_snapshot
+   * - search_snapshot_logs
+   */
+];
+
+/**
+ * Tool Registry class for managing MCP tools
+ * Provides centralized access to tool definitions and metadata
+ */
+export class ToolRegistry {
+  constructor() {
+    this.tools = new Map();
+    this.loadTools();
+  }
+
+  /**
+   * Loads all tool definitions into the registry
+   */
+  loadTools() {
+    toolDefinitions.forEach(tool => {
+      this.tools.set(tool.name, tool);
+    });
+  }
+
+  /**
+   * Gets all registered tools
+   * @returns {Array} Array of tool definitions
+   */
+  getAllTools() {
+    return Array.from(this.tools.values());
+  }
+
+  /**
+   * Gets a specific tool by name
+   * @param {string} name - Tool name
+   * @returns {Object|null} Tool definition or null if not found
+   */
+  getTool(name) {
+    return this.tools.get(name) || null;
+  }
+
+  /**
+   * Checks if a tool exists
+   * @param {string} name - Tool name
+   * @returns {boolean} True if tool exists
+   */
+  hasTool(name) {
+    return this.tools.has(name);
+  }
+
+  /**
+   * Gets tool names grouped by category for organization
+   * @returns {Object} Object with tool names grouped by functionality
+   */
+  getToolsByCategory() {
+    const categories = {
+      chrome: ['launch_chrome', 'connect_to_existing_chrome', 'check_connection', 'force_reset'],
+      navigation: ['navigate_to'],
+      debugging: ['pause_execution', 'resume_execution', 'step_over', 'set_breakpoint', 'get_scopes'],
+      content: ['get_page_content', 'take_screenshot', 'evaluate_expression', 'get_logs'],
+      element: ['get_selected_element', 'apply_css_to_selected', 'execute_js_on_selected', 'clear_selected_element'],
+      workflow: ['get_workflow_recording', 'list_workflow_recordings', 'play_workflow_recording', 'play_workflow_by_name'],
+      restore: ['save_restore_point', 'restore_from_point', 'list_restore_points'],
+      frames: ['chromedebug_show_frames', 'get_frame_session_info', 'get_frame', 'search_frame_logs', 'get_frame_logs_paginated', 'get_frame_screenshot'],
+      interactions: ['get_screen_interactions'],
+      system: ['get_websocket_info'],
+    };
+
+    return categories;
+  }
+}