@jshookmcp/jshook 0.2.2 → 0.2.5

package/dist/src/server/domains/browser/definitions.tools.page-system.js

@@ -1,252 +1,110 @@
+import { tool } from '../../registry/tool-builder.js';
 export const browserPageSystemTools = [
-    {
-        name: 'console_enable',
-        description: 'Enable console monitoring to capture console.log, console.error, etc.',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'console_get_logs',
-        description: 'Get captured console logs',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                type: {
-                    type: 'string',
-                    description: 'Filter by log type',
-                    enum: ['log', 'warn', 'error', 'info', 'debug'],
-                },
-                limit: {
-                    type: 'number',
-                    description: 'Maximum number of logs to return',
-                },
-                since: {
-                    type: 'number',
-                    description: 'Only return logs after this timestamp',
-                },
-            },
-        },
-    },
-    {
-        name: 'console_execute',
-        description: 'Execute JavaScript expression in console context',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                expression: {
-                    type: 'string',
-                    description: 'JavaScript expression to execute',
-                },
-            },
-            required: ['expression'],
-        },
-    },
-    {
-        name: 'dom_get_computed_style',
-        description: 'Get computed CSS styles of an element',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                selector: {
-                    type: 'string',
-                    description: 'CSS selector',
-                },
-            },
-            required: ['selector'],
-        },
-    },
-    {
-        name: 'dom_find_by_text',
-        description: 'Find elements by text content (useful for dynamic content)',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                text: {
-                    type: 'string',
-                    description: 'Text to search for',
-                },
-                tag: {
-                    type: 'string',
-                    description: 'Optional tag name to filter (e.g., "button", "a")',
-                },
-            },
-            required: ['text'],
-        },
-    },
-    {
-        name: 'dom_get_xpath',
-        description: 'Get XPath of an element',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                selector: {
-                    type: 'string',
-                    description: 'CSS selector',
-                },
-            },
-            required: ['selector'],
-        },
-    },
-    {
-        name: 'dom_is_in_viewport',
-        description: 'Check if element is visible in viewport',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                selector: {
-                    type: 'string',
-                    description: 'CSS selector',
-                },
-            },
-            required: ['selector'],
-        },
-    },
-    {
-        name: 'page_get_performance',
-        description: 'Get page performance metrics (load time, network time, etc.)',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'page_inject_script',
-        description: 'Inject JavaScript code into page',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                script: {
-                    type: 'string',
-                    description: 'JavaScript code to inject',
-                },
-            },
-            required: ['script'],
-        },
-    },
-    {
-        name: 'page_set_cookies',
-        description: 'Set cookies for the page',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                cookies: {
-                    type: 'array',
-                    description: 'Array of cookie objects',
-                    items: {
-                        type: 'object',
-                        properties: {
-                            name: { type: 'string' },
-                            value: { type: 'string' },
-                            domain: { type: 'string' },
-                            path: { type: 'string' },
-                            expires: { type: 'number' },
-                            httpOnly: { type: 'boolean' },
-                            secure: { type: 'boolean' },
-                            sameSite: { type: 'string', enum: ['Strict', 'Lax', 'None'] },
-                        },
-                        required: ['name', 'value'],
-                    },
-                },
-            },
-            required: ['cookies'],
-        },
-    },
-    {
-        name: 'page_get_cookies',
-        description: 'Get all cookies for the page',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'page_clear_cookies',
-        description: 'Clear all cookies',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'page_set_viewport',
-        description: 'Set viewport size',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                width: {
-                    type: 'number',
-                    description: 'Viewport width',
-                },
-                height: {
-                    type: 'number',
-                    description: 'Viewport height',
-                },
-            },
-            required: ['width', 'height'],
-        },
-    },
-    {
-        name: 'page_emulate_device',
-        description: 'Emulate mobile device (iPhone, iPad, Android)',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                device: {
-                    type: 'string',
-                    description: 'Device to emulate. Supports canonical values (iPhone, iPad, Android) and aliases like "iPhone 13" / "iPhone 14".',
-                },
-            },
-            required: ['device'],
-        },
-    },
-    {
-        name: 'page_get_local_storage',
-        description: 'Get all localStorage items',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'page_set_local_storage',
-        description: 'Set localStorage item',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                key: {
-                    type: 'string',
-                    description: 'Storage key',
-                },
-                value: {
-                    type: 'string',
-                    description: 'Storage value',
-                },
-            },
-            required: ['key', 'value'],
-        },
-    },
-    {
-        name: 'page_press_key',
-        description: 'Press a keyboard key (e.g., "Enter", "Escape", "ArrowDown")',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                key: {
-                    type: 'string',
-                    description: 'Key to press',
-                },
-            },
-            required: ['key'],
-        },
-    },
-    {
-        name: 'page_get_all_links',
-        description: 'Get all links on the page',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
+    tool('console_enable')
+        .desc('Enable console monitoring to capture console.log, console.error, etc.')
+        .idempotent()
+        .build(),
+    tool('console_get_logs')
+        .desc('Get captured console logs')
+        .enum('type', ['log', 'warn', 'error', 'info', 'debug'], 'Filter by log type')
+        .number('limit', 'Maximum number of logs to return')
+        .number('since', 'Only return logs after this timestamp')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('console_execute')
+        .desc('Execute JavaScript expression in console context')
+        .string('expression', 'JavaScript expression to execute')
+        .required('expression')
+        .openWorld()
+        .build(),
+    tool('dom_get_computed_style')
+        .desc('Get computed CSS styles of an element')
+        .string('selector', 'CSS selector')
+        .required('selector')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('dom_find_by_text')
+        .desc('Find elements by text content (useful for dynamic content)')
+        .string('text', 'Text to search for')
+        .string('tag', 'Optional tag name to filter (e.g., "button", "a")')
+        .required('text')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('dom_get_xpath')
+        .desc('Get XPath of an element')
+        .string('selector', 'CSS selector')
+        .required('selector')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('dom_is_in_viewport')
+        .desc('Check if element is visible in viewport')
+        .string('selector', 'CSS selector')
+        .required('selector')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('page_get_performance')
+        .desc('Get page performance metrics (load time, network time, etc.)')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('page_inject_script')
+        .desc('Inject JavaScript code into page')
+        .string('script', 'JavaScript code to inject')
+        .required('script')
+        .openWorld()
+        .build(),
+    tool('page_set_cookies')
+        .desc('Set cookies for the page')
+        .array('cookies', {
+        type: 'object',
+        properties: {
+            name: { type: 'string' },
+            value: { type: 'string' },
+            domain: { type: 'string' },
+            path: { type: 'string' },
+            expires: { type: 'number' },
+            httpOnly: { type: 'boolean' },
+            secure: { type: 'boolean' },
+            sameSite: { type: 'string', enum: ['Strict', 'Lax', 'None'] },
+        },
+        required: ['name', 'value'],
+    }, 'Array of cookie objects')
+        .required('cookies')
+        .idempotent()
+        .build(),
+    tool('page_get_cookies').desc('Get all cookies for the page').readOnly().idempotent().build(),
+    tool('page_clear_cookies').desc('Clear all cookies').destructive().idempotent().build(),
+    tool('page_set_viewport')
+        .desc('Set viewport size')
+        .number('width', 'Viewport width')
+        .number('height', 'Viewport height')
+        .required('width', 'height')
+        .idempotent()
+        .build(),
+    tool('page_emulate_device')
+        .desc('Emulate mobile device (iPhone, iPad, Android)')
+        .string('device', 'Device to emulate. Supports canonical values (iPhone, iPad, Android) and aliases like "iPhone 13" / "iPhone 14".')
+        .required('device')
+        .idempotent()
+        .build(),
+    tool('page_get_local_storage').desc('Get all localStorage items').readOnly().idempotent().build(),
+    tool('page_set_local_storage')
+        .desc('Set localStorage item')
+        .string('key', 'Storage key')
+        .string('value', 'Storage value')
+        .required('key', 'value')
+        .idempotent()
+        .build(),
+    tool('page_press_key')
+        .desc('Press a keyboard key (e.g., "Enter", "Escape", "ArrowDown")')
+        .string('key', 'Key to press')
+        .required('key')
+        .openWorld()
+        .build(),
+    tool('page_get_all_links').desc('Get all links on the page').readOnly().idempotent().build(),
 ];

package/dist/src/server/domains/browser/definitions.tools.runtime.js

@@ -1,7 +1,7 @@
+import { tool } from '../../registry/tool-builder.js';
 export const browserRuntimeTools = [
-    {
-        name: 'get_detailed_data',
-        description: ` Retrieve detailed data using detailId token.
+    tool('get_detailed_data')
+        .desc(` Retrieve detailed data using detailId token.
 
 When tools return large data, they provide a detailId instead of full data to prevent context overflow.
 Use this tool to retrieve the full data or specific parts.
@@ -9,25 +9,15 @@ Use this tool to retrieve the full data or specific parts.
 Examples:
 - get_detailed_data("detail_abc123") -> Get full data
 - get_detailed_data("detail_abc123", path="frontierSign") -> Get specific property
-- get_detailed_data("detail_abc123", path="methods.0") -> Get first method`,
-        inputSchema: {
-            type: 'object',
-            properties: {
-                detailId: {
-                    type: 'string',
-                    description: 'Detail ID token from previous tool response',
-                },
-                path: {
-                    type: 'string',
-                    description: 'Optional: Path to specific data (e.g., "frontierSign" or "methods.0")',
-                },
-            },
-            required: ['detailId'],
-        },
-    },
-    {
-        name: 'browser_launch',
-        description: `Launch browser instance.
+- get_detailed_data("detail_abc123", path="methods.0") -> Get first method`)
+        .string('detailId', 'Detail ID token from previous tool response')
+        .string('path', 'Optional: Path to specific data (e.g., "frontierSign" or "methods.0")')
+        .required('detailId')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('browser_launch')
+        .desc(`Launch browser instance.
 
 Drivers:
 - chrome (default): rebrowser-puppeteer-core, Chromium-based, full CDP support (debugger, network, stealth scripts, etc.)
@@ -39,62 +29,22 @@ Modes:
 - launch (default): launch a local browser instance
 - connect: reuse an existing browser instance
   - chrome: connect via browserURL (http://host:port), wsEndpoint, or Chrome 144+ autoConnect
-  - camoufox: connect via wsEndpoint from camoufox_server_launch`,
-        inputSchema: {
-            type: 'object',
-            properties: {
-                driver: {
-                    type: 'string',
-                    description: 'Browser driver. chrome = rebrowser-puppeteer-core (full CDP support). camoufox = Firefox anti-detect (requires: npx camoufox-js fetch).',
-                    enum: ['chrome', 'camoufox'],
-                    default: 'chrome',
-                },
-                headless: {
-                    type: 'boolean',
-                    description: 'Run headless (default follows PUPPETEER_HEADLESS env; set false to show browser window for manual login)',
-                    default: false,
-                },
-                os: {
-                    type: 'string',
-                    description: 'OS fingerprint to spoof (camoufox only)',
-                    enum: ['windows', 'macos', 'linux'],
-                    default: 'windows',
-                },
-                mode: {
-                    type: 'string',
-                    description: 'Launch mode. launch = start local browser. connect = reuse existing browser (chrome: browserURL/wsEndpoint/autoConnect, camoufox: wsEndpoint).',
-                    enum: ['launch', 'connect'],
-                    default: 'launch',
-                },
-                browserURL: {
-                    type: 'string',
-                    description: 'HTTP URL of existing browser debug endpoint (chrome connect mode). Example: http://127.0.0.1:9222',
-                },
-                wsEndpoint: {
-                    type: 'string',
-                    description: 'WebSocket endpoint to connect to (chrome or camoufox connect mode). For camoufox, get this from camoufox_server_launch.',
-                },
-                autoConnect: {
-                    type: 'boolean',
-                    description: 'Chrome 144+ only. Auto-detect the local Chrome debugging WebSocket from DevToolsActivePort. Requires remote debugging to be enabled at chrome://inspect/#remote-debugging, and Chrome may prompt you to manually approve this client.',
-                    default: false,
-                },
-                channel: {
-                    type: 'string',
-                    description: 'Chrome channel used for autoConnect when userDataDir is not provided.',
-                    enum: ['stable', 'beta', 'dev', 'canary'],
-                    default: 'stable',
-                },
-                userDataDir: {
-                    type: 'string',
-                    description: 'Optional Chrome profile directory for autoConnect. If omitted, the default profile path for the selected channel is used.',
-                },
-            },
-        },
-    },
-    {
-        name: 'camoufox_server_launch',
-        description: `Launch a Camoufox WebSocket server for multi-process / remote connections.
+  - camoufox: connect via wsEndpoint from camoufox_server_launch`)
+        .enum('driver', ['chrome', 'camoufox'], 'Browser driver. chrome = rebrowser-puppeteer-core (full CDP support). camoufox = Firefox anti-detect (requires: npx camoufox-js fetch).', { default: 'chrome' })
+        .boolean('headless', 'Run headless (default follows PUPPETEER_HEADLESS env; set false to show browser window for manual login)', { default: false })
+        .enum('os', ['windows', 'macos', 'linux'], 'OS fingerprint to spoof (camoufox only)', {
+        default: 'windows',
+    })
+        .enum('mode', ['launch', 'connect'], 'Launch mode. launch = start local browser. connect = reuse existing browser (chrome: browserURL/wsEndpoint/autoConnect, camoufox: wsEndpoint).', { default: 'launch' })
+        .string('browserURL', 'HTTP URL of existing browser debug endpoint (chrome connect mode). Example: http://127.0.0.1:9222')
+        .string('wsEndpoint', 'WebSocket endpoint to connect to (chrome or camoufox connect mode). For camoufox, get this from camoufox_server_launch.')
+        .boolean('autoConnect', 'Chrome 144+ only. Auto-detect the local Chrome debugging WebSocket from DevToolsActivePort. Requires remote debugging to be enabled at chrome://inspect/#remote-debugging, and Chrome may prompt you to manually approve this client.', { default: false })
+        .enum('channel', ['stable', 'beta', 'dev', 'canary'], 'Chrome channel used for autoConnect when userDataDir is not provided.', { default: 'stable' })
+        .string('userDataDir', 'Optional Chrome profile directory for autoConnect. If omitted, the default profile path for the selected channel is used.')
+        .openWorld()
+        .build(),
+    tool('camoufox_server_launch')
+        .desc(`Launch a Camoufox WebSocket server for multi-process / remote connections.
 
 Use this when you need concurrent browser instances or want to manage the browser lifecycle separately from the automation client.
 
@@ -104,51 +54,24 @@ Steps:
 3. Use page_navigate and other tools normally
 4. Call camoufox_server_close when done
 
-Requires binaries: npx camoufox-js fetch`,
-        inputSchema: {
-            type: 'object',
-            properties: {
-                port: {
-                    type: 'number',
-                    description: 'Port to listen on (default: auto-assigned)',
-                },
-                ws_path: {
-                    type: 'string',
-                    description: 'WebSocket path (default: auto-generated)',
-                },
-                os: {
-                    type: 'string',
-                    description: 'OS fingerprint to spoof',
-                    enum: ['windows', 'macos', 'linux'],
-                    default: 'windows',
-                },
-                headless: {
-                    type: 'boolean',
-                    description: 'Run headless (default: true)',
-                    default: true,
-                },
-            },
-        },
-    },
-    {
-        name: 'camoufox_server_close',
-        description: 'Close the Camoufox WebSocket server. Connected clients are disconnected.',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'camoufox_server_status',
-        description: 'Get the current status of the Camoufox WebSocket server (running, wsEndpoint).',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'browser_attach',
-        description: `Attach to an existing browser instance via Chrome DevTools Protocol (CDP).
+Requires binaries: npx camoufox-js fetch`)
+        .number('port', 'Port to listen on (default: auto-assigned)')
+        .string('ws_path', 'WebSocket path (default: auto-generated)')
+        .enum('os', ['windows', 'macos', 'linux'], 'OS fingerprint to spoof', { default: 'windows' })
+        .boolean('headless', 'Run headless (default: true)', { default: true })
+        .openWorld()
+        .build(),
+    tool('camoufox_server_close')
+        .desc('Close the Camoufox WebSocket server. Connected clients are disconnected.')
+        .destructive()
+        .build(),
+    tool('camoufox_server_status')
+        .desc('Get the current status of the Camoufox WebSocket server (running, wsEndpoint).')
+        .readOnly()
+        .idempotent()
+        .build(),
+    tool('browser_attach')
+        .desc(`Attach to an existing browser instance via Chrome DevTools Protocol (CDP).
 
 Use this when a browser is already running with remote debugging enabled.
 Supports browserURL (http://host:port), WebSocket endpoint (ws://...), and Chrome 144+ autoConnect.
@@ -159,55 +82,19 @@ Example:
 - browser_attach(autoConnect=true, channel="stable")
 - browser_attach(browserURL="http://127.0.0.1:9222", pageIndex=0)
 
-After attaching, use page_navigate / page_screenshot / debugger_enable normally.`,
-        inputSchema: {
-            type: 'object',
-            properties: {
-                browserURL: {
-                    type: 'string',
-                    description: 'HTTP URL of the remote debugging endpoint (e.g., http://127.0.0.1:9222)',
-                },
-                wsEndpoint: {
-                    type: 'string',
-                    description: 'WebSocket URL from /json/version (e.g., ws://127.0.0.1:9222/devtools/browser/xxx)',
-                },
-                autoConnect: {
-                    type: 'boolean',
-                    description: 'Chrome 144+ only. Auto-detect the local Chrome debugging WebSocket from DevToolsActivePort. Requires remote debugging to be enabled at chrome://inspect/#remote-debugging, and Chrome may prompt you to manually approve this client.',
-                    default: false,
-                },
-                channel: {
-                    type: 'string',
-                    description: 'Chrome channel used for autoConnect when userDataDir is not provided.',
-                    enum: ['stable', 'beta', 'dev', 'canary'],
-                    default: 'stable',
-                },
-                userDataDir: {
-                    type: 'string',
-                    description: 'Optional Chrome profile directory for autoConnect. If omitted, the default profile path for the selected channel is used.',
-                },
-                pageIndex: {
-                    type: 'number',
-                    description: 'Index of the page/tab to activate (default: 0)',
-                    default: 0,
-                },
-            },
-        },
-    },
-    {
-        name: 'browser_close',
-        description: 'Close browser instance',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
-    {
-        name: 'browser_status',
-        description: 'Get browser status (running, pages count, version)',
-        inputSchema: {
-            type: 'object',
-            properties: {},
-        },
-    },
+After attaching, use page_navigate / page_screenshot / debugger_enable normally.`)
+        .string('browserURL', 'HTTP URL of the remote debugging endpoint (e.g., http://127.0.0.1:9222)')
+        .string('wsEndpoint', 'WebSocket URL from /json/version (e.g., ws://127.0.0.1:9222/devtools/browser/xxx)')
+        .boolean('autoConnect', 'Chrome 144+ only. Auto-detect the local Chrome debugging WebSocket from DevToolsActivePort. Requires remote debugging to be enabled at chrome://inspect/#remote-debugging, and Chrome may prompt you to manually approve this client.', { default: false })
+        .enum('channel', ['stable', 'beta', 'dev', 'canary'], 'Chrome channel used for autoConnect when userDataDir is not provided.', { default: 'stable' })
+        .string('userDataDir', 'Optional Chrome profile directory for autoConnect. If omitted, the default profile path for the selected channel is used.')
+        .number('pageIndex', 'Index of the page/tab to activate (default: 0)', { default: 0 })
+        .openWorld()
+        .build(),
+    tool('browser_close').desc('Close browser instance').destructive().build(),
+    tool('browser_status')
+        .desc('Get browser status (running, pages count, version)')
+        .readOnly()
+        .idempotent()
+        .build(),
 ];