agent-web-interface 4.4.0 → 4.5.0

package/dist/src/tools/tool-registration.js

@@ -0,0 +1,180 @@
+/**
+ * Tool Registration
+ *
+ * Extracts all 23 MCP tool registrations into a reusable function.
+ * Used by both stdio (index.ts) and HTTP (http-gateway.ts) entry points.
+ */
+// Import all tool handlers
+import { listPages, closePage } from './navigation-tools.js';
+import { navigate, goBack, goForward, reload } from './navigation-tools.js';
+import { captureSnapshot, findElements, getNodeDetails, scrollElementIntoView, scrollPage, } from './observation-tools.js';
+import { click, type, press, select, hover } from './interaction-tools.js';
+import { drag, wheel, takeScreenshot } from './viewport-tools.js';
+import { inspectCanvas } from './canvas-tools.js';
+import { getFormUnderstanding, getFieldContext } from './form-tools.js';
+import { readPage } from './readability-tools.js';
+// Import all input schemas
+import { ListPagesInputSchema, ClosePageInputSchema, NavigateInputSchema, GoBackInputSchema, GoForwardInputSchema, ReloadInputSchema, CaptureSnapshotInputSchema, FindElementsInputSchema, GetNodeDetailsInputSchema, ScrollElementIntoViewInputSchemaBase, ScrollPageInputSchema, ClickInputSchemaBase, TypeInputSchemaBase, PressInputSchema, SelectInputSchemaBase, HoverInputSchemaBase, DragInputSchemaBase, WheelInputSchemaBase, TakeScreenshotInputSchemaBase, InspectCanvasInputSchemaBase, ReadPageInputSchema, } from './tool-schemas.js';
+import { GetFormUnderstandingInputSchema, GetFieldContextInputSchema } from './form-tools.js';
+/** Tools that should not trigger lazy browser initialization */
+const SKIP_BROWSER_INIT = new Set(['close_page', 'list_pages', 'navigate']);
+/**
+ * Register all browser automation tools on an MCP server.
+ *
+ * Browser initialization is session-scoped: each ToolContext owns its own
+ * SessionManager and lazily launches/connects via ctx.ensureBrowser().
+ *
+ * @param server - The MCP server instance
+ * @param resolveCtx - Function that returns the ToolContext for the current request
+ */
+export function registerAllTools(server, resolveCtx) {
+    // Helper: resolve context first, then ensure browser, then run handler.
+    // Context resolution is cheap (returns existing SessionController),
+    // so it's safe to resolve before the browser is running.
+    function wrap(handler, toolName) {
+        return async (input) => {
+            const ctx = await resolveCtx();
+            if (!SKIP_BROWSER_INIT.has(toolName ?? '')) {
+                await ctx.ensureBrowser();
+            }
+            return handler(input, ctx);
+        };
+    }
+    // ============================================================================
+    // SESSION TOOLS
+    // ============================================================================
+    server.registerTool('list_pages', {
+        title: 'List Pages',
+        description: 'List all open browser pages with their page_id, URL, and title.',
+        inputSchema: ListPagesInputSchema.shape,
+    }, wrap(listPages, 'list_pages'));
+    server.registerTool('close_page', {
+        title: 'Close Page',
+        description: 'Close a browser tab. Use list_pages first to get the page_id.',
+        inputSchema: ClosePageInputSchema.shape,
+    }, wrap(closePage, 'close_page'));
+    // ============================================================================
+    // NAVIGATION TOOLS
+    // ============================================================================
+    server.registerTool('navigate', {
+        title: 'Navigate',
+        description: 'Go to a URL. Returns page snapshot with interactive elements.',
+        inputSchema: NavigateInputSchema.shape,
+    }, wrap(navigate));
+    server.registerTool('go_back', {
+        title: 'Go Back',
+        description: 'Go back one page in browser history.',
+        inputSchema: GoBackInputSchema.shape,
+    }, wrap(goBack));
+    server.registerTool('go_forward', {
+        title: 'Go Forward',
+        description: 'Go forward one page in browser history.',
+        inputSchema: GoForwardInputSchema.shape,
+    }, wrap(goForward));
+    server.registerTool('reload', {
+        title: 'Reload',
+        description: 'Refresh the current page.',
+        inputSchema: ReloadInputSchema.shape,
+    }, wrap(reload));
+    server.registerTool('snapshot', {
+        title: 'Snapshot',
+        description: 'Re-capture the page state without performing any action. Use when the page may have changed on its own (timers, live updates, animations).',
+        inputSchema: CaptureSnapshotInputSchema.shape,
+    }, wrap(captureSnapshot));
+    // ============================================================================
+    // OBSERVATION TOOLS
+    // ============================================================================
+    server.registerTool('find', {
+        title: 'Find',
+        description: 'Search for interactive elements OR read page text content. Filter by `kind` (button, link, textbox, canvas), `label` (case-insensitive substring match), or `region` (header, main, footer).',
+        inputSchema: FindElementsInputSchema.shape,
+    }, wrap(findElements));
+    server.registerTool('get_element', {
+        title: 'Get Element',
+        description: 'Get complete details for one element: exact position, size, state, attributes.',
+        inputSchema: GetNodeDetailsInputSchema.shape,
+    }, wrap(getNodeDetails));
+    server.registerTool('screenshot', {
+        title: 'Screenshot',
+        description: 'Capture a screenshot of the current page or a specific element.',
+        inputSchema: TakeScreenshotInputSchemaBase.shape,
+    }, wrap(takeScreenshot));
+    // ============================================================================
+    // INTERACTION TOOLS
+    // ============================================================================
+    server.registerTool('scroll_to', {
+        title: 'Scroll To',
+        description: 'Scroll until a specific element is visible in the viewport.',
+        inputSchema: ScrollElementIntoViewInputSchemaBase.shape,
+    }, wrap(scrollElementIntoView));
+    server.registerTool('scroll', {
+        title: 'Scroll',
+        description: 'Scroll the viewport up or down by pixels.',
+        inputSchema: ScrollPageInputSchema.shape,
+    }, wrap(scrollPage));
+    server.registerTool('click', {
+        title: 'Click Element',
+        description: 'Click an element or at viewport coordinates.',
+        inputSchema: ClickInputSchemaBase.shape,
+    }, wrap(click));
+    server.registerTool('type', {
+        title: 'Type Text',
+        description: 'Type text into an input field or text area.',
+        inputSchema: TypeInputSchemaBase.shape,
+    }, wrap(type));
+    server.registerTool('press', {
+        title: 'Press Key',
+        description: 'Press a keyboard key with optional modifiers.',
+        inputSchema: PressInputSchema.shape,
+    }, wrap(press));
+    server.registerTool('select', {
+        title: 'Select Option',
+        description: 'Choose an option from a dropdown menu by value or visible text.',
+        inputSchema: SelectInputSchemaBase.shape,
+    }, wrap(select));
+    server.registerTool('hover', {
+        title: 'Hover Element',
+        description: 'Move mouse over an element without clicking. Triggers hover menus and tooltips.',
+        inputSchema: HoverInputSchemaBase.shape,
+    }, wrap(hover));
+    server.registerTool('drag', {
+        title: 'Drag',
+        description: 'Drag from one point to another.',
+        inputSchema: DragInputSchemaBase.shape,
+    }, wrap(drag));
+    server.registerTool('wheel', {
+        title: 'Wheel',
+        description: 'Dispatch a mouse wheel event at specific coordinates. Use for scroll-to-zoom (with Control modifier) or horizontal scrolling.',
+        inputSchema: WheelInputSchemaBase.shape,
+    }, wrap(wheel));
+    // ============================================================================
+    // CANVAS INSPECTION TOOLS
+    // ============================================================================
+    server.registerTool('inspect_canvas', {
+        title: 'Inspect Canvas',
+        description: 'Analyze a canvas element: auto-detect the rendering library, query its scene graph, and return an annotated screenshot with coordinate grid overlay.',
+        inputSchema: InspectCanvasInputSchemaBase.shape,
+    }, wrap(inspectCanvas));
+    // ============================================================================
+    // FORM UNDERSTANDING TOOLS
+    // ============================================================================
+    server.registerTool('get_form', {
+        title: 'Get Form',
+        description: 'Analyze all forms on the page: fields, required inputs, validation rules, and field dependencies.',
+        inputSchema: GetFormUnderstandingInputSchema.shape,
+    }, wrap(getFormUnderstanding));
+    server.registerTool('get_field', {
+        title: 'Get Field',
+        description: 'Get detailed info about one form field: purpose, valid input formats, dependencies, and suggested values.',
+        inputSchema: GetFieldContextInputSchema.shape,
+    }, wrap(getFieldContext));
+    // ============================================================================
+    // READABILITY TOOLS
+    // ============================================================================
+    server.registerTool('read_page', {
+        title: 'Read Page',
+        description: 'Extract the main readable content from the page, removing navigation, ads, and clutter. Uses Mozilla Readability (Firefox Reader View engine). Best for articles, blog posts, documentation, and content-heavy pages.',
+        inputSchema: ReadPageInputSchema.shape,
+    }, wrap(readPage));
+}
+//# sourceMappingURL=tool-registration.js.map

package/dist/src/tools/tool-registration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-registration.js","sourceRoot":"","sources":["../../../src/tools/tool-registration.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,2BAA2B;AAC3B,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EACL,eAAe,EACf,YAAY,EACZ,cAAc,EACd,qBAAqB,EACrB,UAAU,GACX,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAElD,2BAA2B;AAC3B,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,EACjB,0BAA0B,EAC1B,uBAAuB,EACvB,yBAAyB,EACzB,oCAAoC,EACpC,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,6BAA6B,EAC7B,4BAA4B,EAC5B,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,+BAA+B,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAQ9F,gEAAgE;AAChE,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,YAAY,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC;AAE5E;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAqB,EAAE,UAA2B;IACjF,wEAAwE;IACxE,oEAAoE;IACpE,yDAAyD;IACzD,SAAS,IAAI,CACX,OAAuD,EACvD,QAAiB;QAEjB,OAAO,KAAK,EAAE,KAAQ,EAAE,EAAE;YACxB,MAAM,GAAG,GAAG,MAAM,UAAU,EAAE,CAAC;YAC/B,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC3C,MAAM,GAAG,CAAC,aAAa,EAAE,CAAC;YAC5B,CAAC;YACD,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC;IAED,+EAA+E;IAC/E,gBAAgB;IAChB,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,iEAAiE;QAC9E,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAC9B,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,+DAA+D;QAC5E,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAC9B,CAAC;IAEF,+EAA+E;IAC/E,mBAAmB;IACnB,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,UAAU,EACV;QACE,KAAK,EAAE,UAAU;QACjB,WAAW,EAAE,+DAA+D;QAC5E,WAAW,EAAE,mBAAmB,CAAC,KAAK;KACvC,EACD,IAAI,CAAC,QAAQ,CAAC,CACf,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,SAAS,EACT;QACE,KAAK,EAAE,SAAS;QAChB,WAAW,EAAE,sCAAsC;QACnD,WAAW,EAAE,iBAAiB,CAAC,KAAK;KACrC,EACD,IAAI,CAAC,MAAM,CAAC,CACb,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,yCAAyC;QACtD,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,IAAI,CAAC,SAAS,CAAC,CAChB,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,2BAA2B;QACxC,WAAW,EAAE,iBAAiB,CAAC,KAAK;KACrC,EACD,IAAI,CAAC,MAAM,CAAC,CACb,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,UAAU,EACV;QACE,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,4IAA4I;QAC9I,WAAW,EAAE,0BAA0B,CAAC,KAAK;KAC9C,EACD,IAAI,CAAC,eAAe,CAAC,CACtB,CAAC;IAEF,+EAA+E;IAC/E,oBAAoB;IACpB,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,KAAK,EAAE,MAAM;QACb,WAAW,EACT,8LAA8L;QAChM,WAAW,EAAE,uBAAuB,CAAC,KAAK;KAC3C,EACD,IAAI,CAAC,YAAY,CAAC,CACnB,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,aAAa,EACb;QACE,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,gFAAgF;QAC7F,WAAW,EAAE,yBAAyB,CAAC,KAAK;KAC7C,EACD,IAAI,CAAC,cAAc,CAAC,CACrB,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,YAAY,EACZ;QACE,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,iEAAiE;QAC9E,WAAW,EAAE,6BAA6B,CAAC,KAAK;KACjD,EACD,IAAI,CAAC,cAAc,CAAC,CACrB,CAAC;IAEF,+EAA+E;IAC/E,oBAAoB;IACpB,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,WAAW,EACX;QACE,KAAK,EAAE,WAAW;QAClB,WAAW,EAAE,6DAA6D;QAC1E,WAAW,EAAE,oCAAoC,CAAC,KAAK;KACxD,EACD,IAAI,CAAC,qBAAqB,CAAC,CAC5B,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,KAAK,EAAE,QAAQ;QACf,WAAW,EAAE,2CAA2C;QACxD,WAAW,EAAE,qBAAqB,CAAC,KAAK;KACzC,EACD,IAAI,CAAC,UAAU,CAAC,CACjB,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,OAAO,EACP;QACE,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,8CAA8C;QAC3D,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,IAAI,CAAC,KAAK,CAAC,CACZ,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,KAAK,EAAE,WAAW;QAClB,WAAW,EAAE,6CAA6C;QAC1D,WAAW,EAAE,mBAAmB,CAAC,KAAK;KACvC,EACD,IAAI,CAAC,IAAI,CAAC,CACX,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,OAAO,EACP;QACE,KAAK,EAAE,WAAW;QAClB,WAAW,EAAE,+CAA+C;QAC5D,WAAW,EAAE,gBAAgB,CAAC,KAAK;KACpC,EACD,IAAI,CAAC,KAAK,CAAC,CACZ,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,QAAQ,EACR;QACE,KAAK,EAAE,eAAe;QACtB,WAAW,EAAE,iEAAiE;QAC9E,WAAW,EAAE,qBAAqB,CAAC,KAAK;KACzC,EACD,IAAI,CAAC,MAAM,CAAC,CACb,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,OAAO,EACP;QACE,KAAK,EAAE,eAAe;QACtB,WAAW,EACT,iFAAiF;QACnF,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,IAAI,CAAC,KAAK,CAAC,CACZ,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,MAAM,EACN;QACE,KAAK,EAAE,MAAM;QACb,WAAW,EAAE,iCAAiC;QAC9C,WAAW,EAAE,mBAAmB,CAAC,KAAK;KACvC,EACD,IAAI,CAAC,IAAI,CAAC,CACX,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,OAAO,EACP;QACE,KAAK,EAAE,OAAO;QACd,WAAW,EACT,+HAA+H;QACjI,WAAW,EAAE,oBAAoB,CAAC,KAAK;KACxC,EACD,IAAI,CAAC,KAAK,CAAC,CACZ,CAAC;IAEF,+EAA+E;IAC/E,0BAA0B;IAC1B,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,gBAAgB,EAChB;QACE,KAAK,EAAE,gBAAgB;QACvB,WAAW,EACT,sJAAsJ;QACxJ,WAAW,EAAE,4BAA4B,CAAC,KAAK;KAChD,EACD,IAAI,CAAC,aAAa,CAAC,CACpB,CAAC;IAEF,+EAA+E;IAC/E,2BAA2B;IAC3B,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,UAAU,EACV;QACE,KAAK,EAAE,UAAU;QACjB,WAAW,EACT,mGAAmG;QACrG,WAAW,EAAE,+BAA+B,CAAC,KAAK;KACnD,EACD,IAAI,CAAC,oBAAoB,CAAC,CAC3B,CAAC;IAEF,MAAM,CAAC,YAAY,CACjB,WAAW,EACX;QACE,KAAK,EAAE,WAAW;QAClB,WAAW,EACT,2GAA2G;QAC7G,WAAW,EAAE,0BAA0B,CAAC,KAAK;KAC9C,EACD,IAAI,CAAC,eAAe,CAAC,CACtB,CAAC;IAEF,+EAA+E;IAC/E,oBAAoB;IACpB,+EAA+E;IAE/E,MAAM,CAAC,YAAY,CACjB,WAAW,EACX;QACE,KAAK,EAAE,WAAW;QAClB,WAAW,EACT,uNAAuN;QACzN,WAAW,EAAE,mBAAmB,CAAC,KAAK;KACvC,EACD,IAAI,CAAC,QAAQ,CAAC,CACf,CAAC;AACJ,CAAC"}