chore: annotate tools (#351)

Fixes https://github.com/microsoft/playwright-mcp/issues/215

src/tools/common.ts

@@ -22,10 +22,12 @@ const wait: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_wait',
+    title: 'Wait',
     description: 'Wait for a specified time in seconds',
     inputSchema: z.object({
       time: z.number().describe('The time to wait in seconds'),
     }),
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {
@@ -43,8 +45,10 @@ const close = defineTool({
 
   schema: {
     name: 'browser_close',
+    title: 'Close browser',
     description: 'Close the page',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {
@@ -61,11 +65,13 @@ const resize: ToolFactory = captureSnapshot => defineTool({
   capability: 'core',
   schema: {
     name: 'browser_resize',
+    title: 'Resize browser window',
     description: 'Resize the browser window',
     inputSchema: z.object({
       width: z.number().describe('Width of the browser window'),
       height: z.number().describe('Height of the browser window'),
     }),
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {

src/tools/console.ts

@@ -21,8 +21,10 @@ const console = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_console_messages',
+    title: 'Get console messages',
     description: 'Returns all console messages',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
   handle: async context => {
     const messages = context.currentTabOrDie().console();

src/tools/dialogs.ts

@@ -22,11 +22,13 @@ const handleDialog: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_handle_dialog',
+    title: 'Handle a dialog',
     description: 'Handle a dialog',
     inputSchema: z.object({
       accept: z.boolean().describe('Whether to accept the dialog.'),
       promptText: z.string().optional().describe('The text of the prompt in case of a prompt dialog.'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {

src/tools/files.ts

@@ -22,10 +22,12 @@ const uploadFile: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_file_upload',
+    title: 'Upload files',
     description: 'Upload one or multiple files',
     inputSchema: z.object({
       paths: z.array(z.string()).describe('The absolute paths to the files to upload. Can be a single file or multiple files.'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {

src/tools/install.ts

@@ -26,8 +26,10 @@ const install = defineTool({
   capability: 'install',
   schema: {
     name: 'browser_install',
+    title: 'Install the browser specified in the config',
     description: 'Install the browser specified in the config. Call this if you get an error about the browser not being installed.',
     inputSchema: z.object({}),
+    type: 'destructive',
   },
 
   handle: async context => {

src/tools/keyboard.ts

@@ -22,10 +22,12 @@ const pressKey: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_press_key',
+    title: 'Press a key',
     description: 'Press a key on the keyboard',
     inputSchema: z.object({
       key: z.string().describe('Name of the key to press or a character to generate, such as `ArrowLeft` or `a`'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {

src/tools/navigate.ts

@@ -22,10 +22,12 @@ const navigate: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_navigate',
+    title: 'Navigate to a URL',
     description: 'Navigate to a URL',
     inputSchema: z.object({
       url: z.string().describe('The URL to navigate to'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -49,8 +51,10 @@ const goBack: ToolFactory = captureSnapshot => defineTool({
   capability: 'history',
   schema: {
     name: 'browser_navigate_back',
+    title: 'Go back',
     description: 'Go back to the previous page',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {
@@ -73,8 +77,10 @@ const goForward: ToolFactory = captureSnapshot => defineTool({
   capability: 'history',
   schema: {
     name: 'browser_navigate_forward',
+    title: 'Go forward',
     description: 'Go forward to the next page',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
   handle: async context => {
     const tab = context.currentTabOrDie();

src/tools/network.ts

@@ -24,8 +24,10 @@ const requests = defineTool({
 
   schema: {
     name: 'browser_network_requests',
+    title: 'List network requests',
     description: 'Returns all network requests since loading the page',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {

src/tools/pdf.ts

@@ -25,8 +25,10 @@ const pdf = defineTool({
 
   schema: {
     name: 'browser_pdf_save',
+    title: 'Save as PDF',
     description: 'Save page as PDF',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {

src/tools/screen.ts

@@ -27,8 +27,10 @@ const screenshot = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_screen_capture',
+    title: 'Take a screenshot',
     description: 'Take a screenshot of the current page',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {
@@ -59,11 +61,13 @@ const moveMouse = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_screen_move_mouse',
+    title: 'Move mouse',
     description: 'Move mouse to a given position',
     inputSchema: elementSchema.extend({
       x: z.number().describe('X coordinate'),
       y: z.number().describe('Y coordinate'),
     }),
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {
@@ -86,11 +90,13 @@ const click = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_screen_click',
+    title: 'Click',
     description: 'Click left mouse button',
     inputSchema: elementSchema.extend({
       x: z.number().describe('X coordinate'),
       y: z.number().describe('Y coordinate'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -117,9 +123,9 @@ const click = defineTool({
 
 const drag = defineTool({
   capability: 'core',
-
   schema: {
     name: 'browser_screen_drag',
+    title: 'Drag mouse',
     description: 'Drag left mouse button',
     inputSchema: elementSchema.extend({
       startX: z.number().describe('Start X coordinate'),
@@ -127,6 +133,7 @@ const drag = defineTool({
       endX: z.number().describe('End X coordinate'),
       endY: z.number().describe('End Y coordinate'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -158,14 +165,15 @@ const drag = defineTool({
 
 const type = defineTool({
   capability: 'core',
-
   schema: {
     name: 'browser_screen_type',
+    title: 'Type text',
     description: 'Type text',
     inputSchema: z.object({
       text: z.string().describe('Text to type into the element'),
       submit: z.boolean().optional().describe('Whether to submit entered text (press Enter after)'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {

src/tools/snapshot.ts

@@ -26,8 +26,10 @@ const snapshot = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_snapshot',
+    title: 'Page snapshot',
     description: 'Capture accessibility snapshot of the current page, this is better than screenshot',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {
@@ -50,8 +52,10 @@ const click = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_click',
+    title: 'Click',
     description: 'Perform click on a web page',
     inputSchema: elementSchema,
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -76,6 +80,7 @@ const drag = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_drag',
+    title: 'Drag mouse',
     description: 'Perform drag and drop between two elements',
     inputSchema: z.object({
       startElement: z.string().describe('Human-readable source element description used to obtain the permission to interact with the element'),
@@ -83,6 +88,7 @@ const drag = defineTool({
       endElement: z.string().describe('Human-readable target element description used to obtain the permission to interact with the element'),
       endRef: z.string().describe('Exact target element reference from the page snapshot'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -108,8 +114,10 @@ const hover = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_hover',
+    title: 'Hover mouse',
     description: 'Hover over element on page',
     inputSchema: elementSchema,
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {
@@ -140,8 +148,10 @@ const type = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_type',
+    title: 'Type text',
     description: 'Type text into editable element',
     inputSchema: typeSchema,
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -184,8 +194,10 @@ const selectOption = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_select_option',
+    title: 'Select option',
     description: 'Select an option in a dropdown',
     inputSchema: selectOptionSchema,
+    type: 'destructive',
   },
 
   handle: async (context, params) => {
@@ -221,8 +233,10 @@ const screenshot = defineTool({
   capability: 'core',
   schema: {
     name: 'browser_take_screenshot',
+    title: 'Take a screenshot',
     description: `Take a screenshot of the current page. You can't perform actions based on the screenshot, use browser_snapshot for actions.`,
     inputSchema: screenshotSchema,
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {

src/tools/tabs.ts

@@ -22,8 +22,10 @@ const listTabs = defineTool({
 
   schema: {
     name: 'browser_tab_list',
+    title: 'List tabs',
     description: 'List browser tabs',
     inputSchema: z.object({}),
+    type: 'readOnly',
   },
 
   handle: async context => {
@@ -47,10 +49,12 @@ const selectTab: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_tab_select',
+    title: 'Select a tab',
     description: 'Select a tab by index',
     inputSchema: z.object({
       index: z.number().describe('The index of the tab to select'),
     }),
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {
@@ -72,10 +76,12 @@ const newTab: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_tab_new',
+    title: 'Open a new tab',
     description: 'Open a new tab',
     inputSchema: z.object({
       url: z.string().optional().describe('The URL to navigate to in the new tab. If not provided, the new tab will be blank.'),
     }),
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {
@@ -99,10 +105,12 @@ const closeTab: ToolFactory = captureSnapshot => defineTool({
 
   schema: {
     name: 'browser_tab_close',
+    title: 'Close a tab',
     description: 'Close a tab',
     inputSchema: z.object({
       index: z.number().optional().describe('The index of the tab to close. Closes current tab if not provided.'),
     }),
+    type: 'destructive',
   },
 
   handle: async (context, params) => {

src/tools/testing.ts

@@ -28,8 +28,10 @@ const generateTest = defineTool({
 
   schema: {
     name: 'browser_generate_playwright_test',
+    title: 'Generate a Playwright test',
     description: 'Generate a Playwright test for given scenario',
     inputSchema: generateTestSchema,
+    type: 'readOnly',
   },
 
   handle: async (context, params) => {

src/tools/tool.ts

@@ -22,8 +22,10 @@ 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;