Testplane MCP

navigate

Navigate to URL in the browser.

• Parameters:
  • url (string, required): The URL to navigate to

closeBrowser

Close the current browser session.

launchBrowser

Launch a new browser session with custom configuration options.

• Parameters:

  • desiredCapabilities (object, optional): WebDriver desired capabilities to forward to the Testplane launcher. Example:

    {
        "browserName": "chrome",
        "goog:chromeOptions": {
            "mobileEmulation": {
                "deviceMetrics": {
                    "width": 375,
                    "height": 667,
                    "pixelRatio": 2.0
                }
            }
        }
    }
    

  • gridUrl (string, optional): WebDriver endpoint to connect to. Default: "local" (lets Testplane MCP manage Chrome and Firefox automatically). Set a Selenium grid URL only when you need other browsers.

  • windowSize (object | string | null, optional): Viewport size for the browser session. Can be:

    • Object format: {"width": 1280, "height": 720}
    • String format: "1280x720"
    • null to reset to default size

Note: Testplane MCP automatically downloads Chrome and Firefox. To launch additional browsers (for example, Safari, Edge, or mobile-specific builds), use the gridUrl parameter to point to your Selenium grid.

listTabs

Get a list of all currently opened browser tabs with their URLs, titles, and active status.

switchToTab

Switch to a specific browser tab by its number (starting from 1).

• Parameters:
  • tabNumber (number, required): The number of the tab to switch to (starting from 1)

openNewTab

Open a new browser tab, optionally navigate to a URL, and automatically switch to it.

• Parameters:
  • url (string, optional): The URL to navigate to in the new tab. If not provided, opens a blank tab

closeTab

Close a specific browser tab by its number (1-based), or close the current tab if no number is provided.

• Parameters:
  • tabNumber (number, optional): The number of the tab to close (starting from 1). If not provided, closes the current tab

Note: Cannot close the last remaining tab. closeBrowser should be used to close the entire browser session.

clickOnElement

Click an element on the page using semantic queries (testing-library-style) or CSS selectors.

• Parameters:

  • locator (object, required): Element location strategy

    • strategy (string, required): Either "testing-library" or "webdriverio"

    For testing-library strategy:

    • queryType (string, required): Semantic query type. One of:
      • "role" - Find by ARIA role (e.g., "button", "link", "heading")
      • "text" - Find by visible text content
      • "labelText" - Find form inputs by their label text
      • "placeholderText" - Find inputs by placeholder text
      • "altText" - Find images by alt text
      • "testId" - Find by data-testid attribute
      • "title" - Find by title attribute
      • "displayValue" - Find inputs by their current value
    • queryValue (string, required): The value to search for
    • queryOptions (object, optional): Additional options:
      • name (string): Accessible name for role queries
      • exact (boolean): Whether to match exact text (default: true)
      • hidden (boolean): Include hidden elements (default: false)
      • level (number): Heading level for role="heading" (1-6)

    For webdriverio strategy:

    • selector (string, required): CSS selector, XPath or WebdriverIO locator

Examples:

// Testing Library strategy
{
  locator: {
    strategy: "testing-library",
    queryType: "role",
    queryValue: "button",
    queryOptions: { name: "Submit" }
  }
}

{
  locator: {
    strategy: "testing-library",
    queryType: "text",
    queryValue: "Click here"
  }
}

{
  locator: {
    strategy: "testing-library",
    queryType: "labelText",
    queryValue: "Email Address"
  }
}

// WebdriverIO strategy
{
  locator: {
    strategy: "webdriverio",
    selector: ".submit-btn"
  }
}

{
  locator: {
    strategy: "webdriverio",
    selector: "button*=Submit"
  }
}

typeIntoElement

Type text into an input element on the page using semantic queries (testing-library-style) or CSS selectors.

• Parameters:

  • locator (object, required): Element location strategy

    • strategy (string, required): Either "testing-library" or "webdriverio"

    For testing-library strategy:

    • queryType (string, required): Semantic query type. One of:
      • "role" - Find by ARIA role (e.g., "textbox", "searchbox")
      • "text" - Find by visible text content
      • "labelText" - Find form inputs by their label text
      • "placeholderText" - Find inputs by placeholder text
      • "altText" - Find images by alt text
      • "testId" - Find by data-testid attribute
      • "title" - Find by title attribute
      • "displayValue" - Find inputs by their current value
    • queryValue (string, required): The value to search for
    • queryOptions (object, optional): Additional options:
      • name (string): Accessible name for role queries
      • exact (boolean): Whether to match exact text (default: true)
      • hidden (boolean): Include hidden elements (default: false)

    For webdriverio strategy:

    • selector (string, required): CSS selector or XPath

  • text (string, required): The text to type into the element

Examples:

See above in the clickOnElement tool.

waitForElement

Wait for an element to appear or disappear on the page. Useful for waiting until page loads fully or loading spinners disappear.

• Parameters:

  • locator (object, required): Element location strategy

    • strategy (string, required): Either "testing-library" or "webdriverio"

    For testing-library strategy:

    • queryType (string, required): Semantic query type. One of:
      • "role" - Find by ARIA role (e.g., "button", "link", "heading")
      • "text" - Find by visible text content
      • "labelText" - Find form inputs by their label text
      • "placeholderText" - Find inputs by placeholder text
      • "altText" - Find images by alt text
      • "testId" - Find by data-testid attribute
      • "title" - Find by title attribute
      • "displayValue" - Find inputs by their current value
    • queryValue (string, required): The value to search for
    • queryOptions (object, optional): Additional options:
      • name (string): Accessible name for role queries
      • exact (boolean): Whether to match exact text (default: true)
      • hidden (boolean): Include hidden elements (default: false)
      • level (number): Heading level for role="heading" (1-6)

    For webdriverio strategy:

    • selector (string, required): CSS selector or XPath

  • disappear (boolean, optional): Whether to wait for element to disappear. Default: false (wait for element to appear)

  • timeout (number, optional): Maximum time to wait in milliseconds. Default: 3000

  • includeSnapshotInResponse (boolean, optional): Whether to include page snapshot in response. Default: true

Examples:

See above in the clickOnElement tool.

takePageSnapshot

Capture a DOM snapshot of the current page with configurable filtering options.

• Parameters:
  • includeTags (array of strings, optional): HTML tags to include in the snapshot besides defaults
  • includeAttrs (array of strings, optional): HTML attributes to include in the snapshot besides defaults
  • excludeTags (array of strings, optional): HTML tags to exclude from the snapshot
  • excludeAttrs (array of strings, optional): HTML attributes to exclude from the snapshot
  • truncateText (boolean, optional): Whether to truncate long text content (default: true)
  • maxTextLength (number, optional): Maximum length of text content before truncation

Note: By default, only useful tags and attributes are included in snapshots. The response will indicate what was omitted. Use the filtering options only if you need specific content that's not included by default.

takeViewportScreenshot

Capture a PNG screenshot of the current browser viewport.

• Parameters:
  • filePath (string, optional): Path to save the screenshot (defaults to tmp directory with timestamp in file name)

Note: Screenshots are saved as PNG files. If no filePath is provided, the screenshot will be saved to the system's temporary directory with a filePath like viewport-{timestamp}.png.