mirror of
https://github.com/microsoft/playwright-mcp.git
synced 2025-07-27 09:02:26 +08:00
685dea9e19
- [Why do I need `.js` extension?](https://stackoverflow.com/a/77150985/6512681) - [Why setting `rootDir` in the `tsconfig.json`?](https://stackoverflow.com/a/58941798/6512681) - [How to ensure that we add the `.js` extension via ESLint](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/extensions.md#importextensions) Fixes https://github.com/microsoft/playwright-mcp/issues/302
67 lines
2.0 KiB
TypeScript
67 lines
2.0 KiB
TypeScript
/**
|
|
* 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 { ImageContent, TextContent } from '@modelcontextprotocol/sdk/types.js';
|
|
import type { z } from 'zod';
|
|
import type { Context } from '../context.js';
|
|
import type * as playwright from 'playwright';
|
|
import type { ToolCapability } from '../../config.js';
|
|
|
|
export type ToolSchema<Input extends InputType> = {
|
|
name: string;
|
|
description: string;
|
|
inputSchema: Input;
|
|
};
|
|
|
|
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 function defineTool<Input extends InputType>(tool: Tool<Input>): Tool<Input> {
|
|
return tool;
|
|
}
|