Skip to main content
Glama
pvinis
by pvinis

playwright_get_visible_text

Extracts visible text content from web pages using a real browser environment, enabling accurate data retrieval for scraping, testing, or analysis tasks.

Instructions

Get the visible text content of the current page

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Implements the core handler logic for 'playwright_get_visible_text' by using Playwright's page.evaluate to run JavaScript that traverses the DOM TreeWalker for visible text nodes (excluding hidden elements), collects and trims text content.
    export class VisibleTextTool extends BrowserToolBase {
      /**
       * Execute the visible text page tool
       */
      async execute(args: any, context: ToolContext): Promise<ToolResponse> {
        // Check if browser is available
        if (!context.browser || !context.browser.isConnected()) {
          // If browser is not connected, we need to reset the state to force recreation
          resetBrowserState();
          return createErrorResponse(
            "Browser is not connected. The connection has been reset - please retry your navigation."
          );
        }
    
        // Check if page is available and not closed
        if (!context.page || context.page.isClosed()) {
          return createErrorResponse(
            "Page is not available or has been closed. Please retry your navigation."
          );
        }
        return this.safeExecute(context, async (page) => {
          try {
            const visibleText = await page!.evaluate(() => {
              const walker = document.createTreeWalker(
                document.body,
                NodeFilter.SHOW_TEXT,
                {
                  acceptNode: (node) => {
                    const style = window.getComputedStyle(node.parentElement!);
                    return (style.display !== "none" && style.visibility !== "hidden")
                      ? NodeFilter.FILTER_ACCEPT
                      : NodeFilter.FILTER_REJECT;
                  },
                }
              );
              let text = "";
              let node;
              while ((node = walker.nextNode())) {
                const trimmedText = node.textContent?.trim();
                if (trimmedText) {
                  text += trimmedText + "\n";
                }
              }
              return text.trim();
            });
            return createSuccessResponse(`Visible text content:\n${visibleText}`);
          } catch (error) {
            return createErrorResponse(`Failed to get visible text content: ${(error as Error).message}`);
          }
        });
      }
  • Defines the tool's metadata, description, and input schema (no required parameters). Part of createToolDefinitions() used for MCP tool registration.
      name: "playwright_get_visible_text",
      description: "Get the visible text content of the current page",
      inputSchema: {
        type: "object",
        properties: {},
        required: [],
      },
    },
  • Dispatches tool calls matching 'playwright_get_visible_text' to the VisibleTextTool instance's execute method in the main handleToolCall switch statement.
    case "playwright_get_visible_text":
      return await visibleTextTool.execute(args, context);
  • Instantiates the VisibleTextTool class instance (visibleTextTool) during tool initialization in initializeTools().
    if (!visibleTextTool) visibleTextTool = new VisibleTextTool(server);
  • Imports the VisibleTextTool class from its implementation file.
      VisibleTextTool,
      VisibleHtmlTool,
    } from "./tools/browser/visiblePage.js";

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.3/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, and the description is minimal. It does not disclose behavioral traits such as whether it returns plain text stripped of formatting, scripts, or images, nor any limitations or side effects.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no extraneous information, front-loading the core functionality.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a parameterless tool, the description is minimally complete. However, it lacks information on return format, potential errors, or behavior on empty pages, which would be helpful given the context of many sibling tools.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With no parameters and 100% schema coverage, the description adds no additional meaning beyond the schema. Baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool gets the visible text content of the current page, using specific verb and resource. It naturally distinguishes from sibling tools like playwright_get_visible_html which returns HTML.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No usage guidelines provided. The description does not indicate when to use this tool versus alternatives (e.g., playwright_get_visible_html or page analysis tools).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.