Skip to main content
Glama
devskido

Playwright MCP Server

by devskido

playwright_patch

Update specific parts of web content by sending HTTP PATCH requests through browser automation, enabling targeted modifications to web resources.

Instructions

Perform an HTTP PATCH request

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesURL to perform PUT operation
valueYesData to PATCH in the body

Implementation Reference

  • The execute method of PatchRequestTool performs the PATCH HTTP request. It validates JSON input if applicable, sends the request via Playwright's APIRequestContext.patch, retrieves the response text, and formats a success response with status and truncated body.
    async execute(args: any, context: ToolContext): Promise<ToolResponse> {
      return this.safeExecute(context, async (apiContext) => {
        // Check if the value is valid JSON if it starts with { or [
        if (args.value && typeof args.value === 'string' && 
            (args.value.startsWith('{') || args.value.startsWith('['))) {
          try {
            JSON.parse(args.value);
          } catch (error) {
            return createErrorResponse(`Failed to parse request body: ${(error as Error).message}`);
          }
        }
        
        const response = await apiContext.patch(args.url, {
          data: args.value
        });
        
        let responseText;
        try {
          responseText = await response.text();
        } catch (error) {
          responseText = "Unable to get response text";
        }
        
        return createSuccessResponse([
          `PATCH request to ${args.url}`,
          `Status: ${response.status()} ${response.statusText()}`,
          `Response: ${responseText.substring(0, 1000)}${responseText.length > 1000 ? '...' : ''}`
        ]);
      });
    }
  • Tool schema definition including name, description, and input schema requiring 'url' and 'value' parameters.
      name: "playwright_patch",
      description: "Perform an HTTP PATCH request",
      inputSchema: {
        type: "object",
        properties: {
          url: { type: "string", description: "URL to perform PUT operation" },
          value: { type: "string", description: "Data to PATCH in the body" },
        },
        required: ["url", "value"],
      },
    },
  • Dispatch/registration in handleToolCall switch statement that routes 'playwright_patch' tool calls to the PatchRequestTool handler.
    case "playwright_patch":
      return await patchRequestTool.execute(args, context);
  • Instantiation of PatchRequestTool instance during tool initialization in initializeTools function.
    if (!getRequestTool) getRequestTool = new GetRequestTool(server);
    if (!postRequestTool) postRequestTool = new PostRequestTool(server);
    if (!putRequestTool) putRequestTool = new PutRequestTool(server);
    if (!patchRequestTool) patchRequestTool = new PatchRequestTool(server);
    if (!deleteRequestTool) deleteRequestTool = new DeleteRequestTool(server);
  • The safeExecute helper method in ApiToolBase used by PatchRequestTool to ensure API context is available and handle execution errors.
    protected async safeExecute(
      context: ToolContext,
      operation: (apiContext: APIRequestContext) => Promise<ToolResponse>
    ): Promise<ToolResponse> {
      const apiError = this.validateApiContextAvailable(context);
      if (apiError) return apiError;
    
      try {
        return await operation(context.apiContext!);
      } catch (error) {
        return createErrorResponse(`API operation failed: ${(error as Error).message}`);
      }
    }

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden but only states the action without behavioral details. It doesn't disclose authentication needs, rate limits, error handling, or what the PATCH operation entails (e.g., partial updates). This leaves significant gaps for a mutation tool.

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 wasted words. It's front-loaded and appropriately sized for a simple tool, making it easy to parse quickly.

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

Completeness2/5

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

Given this is a mutation tool with no annotations and no output schema, the description is incomplete. It lacks details on behavior, error cases, or return values, which are crucial for safe and effective use in an AI agent context.

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?

Schema description coverage is 100%, so the schema already documents both parameters (url and value). The description adds no additional meaning beyond what the schema provides, such as format examples or constraints, meeting the baseline for high coverage.

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

Purpose3/5

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

The description 'Perform an HTTP PATCH request' states the action (perform) and resource (HTTP PATCH request), making the purpose clear. However, it doesn't distinguish this from sibling tools like playwright_put or playwright_post, which are also HTTP methods, leaving the distinction implicit rather than explicit.

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?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention when to choose PATCH over PUT or POST, nor does it reference sibling tools, leaving usage context entirely to inference from the tool name alone.

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