Skip to content

tool-reference.md

Latest commit

 

History

History
344 lines (207 loc) · 11.3 KB

tool-reference.md

File metadata and controls

344 lines (207 loc) · 11.3 KB

Chrome DevTools MCP Tool Reference

Input automation

click

Description: Clicks on the provided element

Parameters:

  • uid (string) (required): The uid of an element on the page from the page content snapshot
  • dblClick (boolean) (optional): Set to true for double clicks. Default is false.

drag

Description: Drag an element onto another element

Parameters:

  • from_uid (string) (required): The uid of the element to drag
  • to_uid (string) (required): The uid of the element to drop into

fill

Description: Type text into a input, text area or select an option from a <select> element.

Parameters:

  • uid (string) (required): The uid of an element on the page from the page content snapshot
  • value (string) (required): The value to fill in

fill_form

Description: Fill out multiple form elements at once

Parameters:

  • elements (array) (required): Elements from snapshot to fill out.

handle_dialog

Description: If a browser dialog was opened, use this command to handle it

Parameters:

  • action (enum: "accept", "dismiss") (required): Whether to dismiss or accept the dialog
  • promptText (string) (optional): Optional prompt text to enter into the dialog.

hover

Description: Hover over the provided element

Parameters:

  • uid (string) (required): The uid of an element on the page from the page content snapshot

press_key

Description: Press a key or key combination. Use this when other input methods like fill() cannot be used (e.g., keyboard shortcuts, navigation keys, or special key combinations).

Parameters:

  • key (string) (required): A key or a combination (e.g., "Enter", "Control+A", "Control++", "Control+Shift+R"). Modifiers: Control, Shift, Alt, Meta

upload_file

Description: Upload a file through a provided element.

Parameters:

  • filePath (string) (required): The local path of the file to upload
  • uid (string) (required): The uid of the file input element or an element that will open file chooser on the page from the page content snapshot

Navigation automation

close_page

Description: Closes the page by its index. The last open page cannot be closed.

Parameters:

  • pageIdx (number) (required): The index of the page to close. Call list_pages to list pages.

list_pages

Description: Get a list of pages open in the browser.

Parameters: None

navigate_page

Description: Navigates the currently selected page to a URL.

Parameters:

  • ignoreCache (boolean) (optional): Whether to ignore cache on reload.
  • timeout (integer) (optional): Maximum wait time in milliseconds. If set to 0, the default timeout will be used.
  • type (enum: "url", "back", "forward", "reload") (optional): Navigate the page by URL, back or forward in history, or reload.
  • url (string) (optional): Target URL (only type=url)

new_page

Description: Creates a new page

Parameters:

  • url (string) (required): URL to load in a new page.
  • timeout (integer) (optional): Maximum wait time in milliseconds. If set to 0, the default timeout will be used.

select_page

Description: Select a page as a context for future tool calls.

Parameters:

  • pageIdx (number) (required): The index of the page to select. Call list_pages to get available pages.
  • bringToFront (boolean) (optional): Whether to focus the page and bring it to the top.

wait_for

Description: Wait for the specified text to appear on the selected page.

Parameters:

  • text (string) (required): Text to appear on the page
  • timeout (integer) (optional): Maximum wait time in milliseconds. If set to 0, the default timeout will be used.

Emulation

emulate

Description: Emulates various features on the selected page.

Parameters:

  • cpuThrottlingRate (number) (optional): Represents the CPU slowdown factor. Set the rate to 1 to disable throttling. If omitted, throttling remains unchanged.
  • geolocation (unknown) (optional): Geolocation to emulate. Set to null to clear the geolocation override.
  • networkConditions (enum: "No emulation", "Offline", "Slow 3G", "Fast 3G", "Slow 4G", "Fast 4G") (optional): Throttle network. Set to "No emulation" to disable. If omitted, conditions remain unchanged.

resize_page

Description: Resizes the selected page's window so that the page has specified dimension

Parameters:

  • height (number) (required): Page height
  • width (number) (required): Page width

Performance

performance_analyze_insight

Description: Provides more detailed information on a specific Performance Insight of an insight set that was highlighted in the results of a trace recording.

Parameters:

  • insightName (string) (required): The name of the Insight you want more information on. For example: "DocumentLatency" or "LCPBreakdown"
  • insightSetId (string) (required): The id for the specific insight set. Only use the ids given in the "Available insight sets" list.

performance_start_trace

Description: Starts a performance trace recording on the selected page. This can be used to look for performance problems and insights to improve the performance of the page. It will also report Core Web Vital (CWV) scores for the page.

Parameters:

  • autoStop (boolean) (required): Determines if the trace recording should be automatically stopped.
  • reload (boolean) (required): Determines if, once tracing has started, the page should be automatically reloaded.

performance_stop_trace

Description: Stops the active performance trace recording on the selected page.

Parameters: None

Network

get_network_request

Description: Gets a network request by an optional reqid, if omitted returns the currently selected request in the DevTools Network panel.

Parameters:

  • reqid (number) (optional): The reqid of the network request. If omitted returns the currently selected request in the DevTools Network panel.

list_network_requests

Description: List all requests for the currently selected page since the last navigation.

Parameters:

  • includePreservedRequests (boolean) (optional): Set to true to return the preserved requests over the last 3 navigations.
  • pageIdx (integer) (optional): Page number to return (0-based). When omitted, returns the first page.
  • pageSize (integer) (optional): Maximum number of requests to return. When omitted, returns all requests.
  • resourceTypes (array) (optional): Filter requests to only return requests of the specified resource types. When omitted or empty, returns all requests.

Debugging

evaluate_script

Description: Evaluate a JavaScript function inside the currently selected page. Returns the response as JSON so returned values have to JSON-serializable.

Parameters:

  • function (string) (required): A JavaScript function declaration to be executed by the tool in the currently selected page. Example without arguments: () => { return document.title } or async () => { return await fetch("example.com") }. Example with arguments: (el) => { return el.innerText; }

  • args (array) (optional): An optional list of arguments to pass to the function.

get_console_message

Description: Gets a console message by its ID. You can get all messages by calling list_console_messages.

Parameters:

  • msgid (number) (required): The msgid of a console message on the page from the listed console messages

list_console_messages

Description: List all console messages for the currently selected page since the last navigation.

Parameters:

  • includePreservedMessages (boolean) (optional): Set to true to return the preserved messages over the last 3 navigations.
  • pageIdx (integer) (optional): Page number to return (0-based). When omitted, returns the first page.
  • pageSize (integer) (optional): Maximum number of messages to return. When omitted, returns all requests.
  • types (array) (optional): Filter messages to only return messages of the specified resource types. When omitted or empty, returns all messages.

take_screenshot

Description: Take a screenshot of the page or element.

Parameters:

  • filePath (string) (optional): The absolute path, or a path relative to the current working directory, to save the screenshot to instead of attaching it to the response.
  • format (enum: "png", "jpeg", "webp") (optional): Type of format to save the screenshot as. Default is "png"
  • fullPage (boolean) (optional): If set to true takes a screenshot of the full page instead of the currently visible viewport. Incompatible with uid.
  • quality (number) (optional): Compression quality for JPEG and WebP formats (0-100). Higher values mean better quality but larger file sizes. Ignored for PNG format.
  • uid (string) (optional): The uid of an element on the page from the page content snapshot. If omitted takes a pages screenshot.

take_snapshot

Description: Take a text snapshot of the currently selected page based on the a11y tree. The snapshot lists page elements along with a unique identifier (uid). Always use the latest snapshot. Prefer taking a snapshot over taking a screenshot. The snapshot indicates the element selected in the DevTools Elements panel (if any).

Parameters:

  • filePath (string) (optional): The absolute path, or a path relative to the current working directory, to save the snapshot to instead of attaching it to the response.
  • verbose (boolean) (optional): Whether to include all possible information available in the full a11y tree. Default is false.