@auto-browse/auto-browse/dist/tools/tool.d.ts

AI-powered browser automation

/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { z } from 'zod';
import type { ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';
import { Context } from '../context.js';
import type * as playwright from 'playwright';
import type { ToolCapability } from '../../config.js';
export type ToolSchema<Input extends InputType> = {
    name: string;
    title: string;
    description: string;
    inputSchema: Input;
    type: 'readOnly' | 'destructive';
};
type InputType = z.Schema;
export type FileUploadModalState = {
    type: 'fileChooser';
    description: string;
    fileChooser: playwright.FileChooser;
};
export type DialogModalState = {
    type: 'dialog';
    description: string;
    dialog: playwright.Dialog;
};
export type ModalState = FileUploadModalState | DialogModalState;
export type ToolActionResult = {
    content?: (ImageContent | TextContent)[];
} | undefined | void;
export type ToolResult = {
    code: string[];
    action?: () => Promise<ToolActionResult>;
    captureSnapshot: boolean;
    waitForNetwork: boolean;
    resultOverride?: ToolActionResult;
};
export type Tool<Input extends InputType = InputType> = {
    capability: ToolCapability;
    schema: ToolSchema<Input>;
    clearsModalState?: ModalState['type'];
    handle: (context: Context, params: z.output<Input>) => Promise<ToolResult>;
};
export type ToolFactory = (snapshot: boolean) => Tool<any>;
export declare function defineTool<Input extends InputType>(tool: Tool<Input>): Tool<Input>;
/**
 * Creates a LangChain-compatible tool from our existing tool definition
 * This allows our tools to be used in LangChain implementations while
 * maintaining their original return type and functionality
 */
export declare function createLangChainTool(baseTool: Tool<any>): import("@langchain/core/tools").DynamicTool;
export {};