Skip to main content
Glama

android_uiautomator_set_text

Set text on Android UI elements by resource ID using UIAutomator automation. Input text into text fields, forms, or input boxes during Android app testing.

Instructions

Set text on a UI element by resource ID using UIAutomator

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
resourceIdYesResource ID of the element (e.g., com.example.app:id/text_input)
textYesText to set in the element
deviceSerialNoSpecific device serial number to target (optional)

Implementation Reference

  • Main handler function that validates input arguments and calls the ADB wrapper to set text on the UI element.
    export async function uiautomatorSetTextHandler(
      adb: ADBWrapper,
      args: any
    ): Promise<{ content: Array<{ type: string; text: string }> }> {
      const { resourceId, text, deviceSerial } = args as UIAutomatorSetTextArgs;
    
      if (!resourceId || typeof resourceId !== 'string') {
        throw new Error('Invalid resource ID: resourceId must be a non-empty string');
      }
    
      if (!text || typeof text !== 'string') {
        throw new Error('Invalid text: text must be a non-empty string');
      }
    
      try {
        await adb.setTextByResourceId(resourceId, text, deviceSerial);
    
        return {
          content: [
            {
              type: 'text',
              text: `Successfully set text on element with resource-id: ${resourceId}\nText: "${text}"`,
            },
          ],
        };
      } catch (error) {
        throw new Error(`UIAutomator set text failed: ${error instanceof Error ? error.message : String(error)}`);
      }
    }
  • Core logic that dumps the UI hierarchy using uiautomator, parses the element bounds by resource ID, clicks to focus, selects and deletes existing text, then inputs the new text.
    async setTextByResourceId(resourceId: string, text: string, deviceSerial?: string): Promise<void> {
      const device = await this.getTargetDevice(deviceSerial);
      const hierarchyFile = '/sdcard/window_dump.xml';
      
      // Get the hierarchy to find the element
      await this.exec(['shell', 'uiautomator', 'dump', hierarchyFile], device);
      const { stdout } = await this.exec(['shell', 'cat', hierarchyFile], device);
      await this.exec(['shell', 'rm', hierarchyFile], device);
      
      // Extract bounds from XML to identify the element type
      const boundsRegex = new RegExp(`resource-id="${resourceId}"[^>]*bounds="\\[(\\d+),(\\d+)\\]\\[(\\d+),(\\d+)\\]"`);
      const match = stdout.match(boundsRegex);
      
      if (match) {
        const x1 = parseInt(match[1], 10);
        const y1 = parseInt(match[2], 10);
        const x2 = parseInt(match[3], 10);
        const y2 = parseInt(match[4], 10);
        
        // Click at the center to focus the element
        const centerX = Math.floor((x1 + x2) / 2);
        const centerY = Math.floor((y1 + y2) / 2);
        
        await this.touch(centerX, centerY, 100, device);
        
        // Clear existing text
        await this.sendKeyEvent('KEYEVENT_CTRL_A', device);
        await this.sendKeyEvent('KEYEVENT_DEL', device);
        
        // Input the new text
        await this.inputText(text, device);
      } else {
        throw new Error(`Element with resource-id ${resourceId} not found in UI hierarchy`);
      }
    }
  • MCP tool schema definition, including name, description, and input schema with required fields resourceId and text.
    {
      name: 'android_uiautomator_set_text',
      description: 'Set text on a UI element by resource ID using UIAutomator',
      inputSchema: {
        type: 'object',
        properties: {
          resourceId: {
            type: 'string',
            description: 'Resource ID of the element (e.g., com.example.app:id/text_input)',
          },
          text: {
            type: 'string',
            description: 'Text to set in the element',
          },
          deviceSerial: {
            type: 'string',
            description: 'Specific device serial number to target (optional)',
          },
        },
        required: ['resourceId', 'text'],
      },
    },
  • src/index.ts:482-483 (registration)
    Tool dispatch registration in the switch statement of the CallToolRequestSchema handler.
    case 'android_uiautomator_set_text':
      return await uiautomatorSetTextHandler(this.adb, args);
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions the method ('using UIAutomator') but doesn't cover critical aspects like whether this requires device interaction permissions, potential side effects (e.g., overwriting existing text), error handling, or performance implications. 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, direct sentence that efficiently conveys the core functionality without unnecessary words. It's front-loaded with the key action ('Set text') and includes essential context ('by resource ID using UIAutomator'), making it highly concise and well-structured.

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?

For a mutation tool with no annotations and no output schema, the description is insufficient. It lacks details on behavioral traits (e.g., permissions, side effects), error conditions, or return values, which are critical for safe and effective tool invocation in an Android automation 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 fully documents all three parameters (resourceId, text, deviceSerial). The description adds no additional parameter semantics beyond what's in the schema, such as examples or constraints. Baseline 3 is appropriate when the schema handles parameter documentation effectively.

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

Purpose4/5

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

The description clearly states the action ('Set text') and target ('on a UI element by resource ID using UIAutomator'), distinguishing it from generic text input tools like 'android_input_text'. However, it doesn't explicitly differentiate from sibling UIAutomator tools like 'android_uiautomator_clear_text' in terms of specific use cases.

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

Usage Guidelines3/5

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

The description implies usage for setting text on UI elements identified by resource ID, which suggests it's for targeted text input in Android apps. However, it lacks explicit guidance on when to use this vs. alternatives like 'android_input_text' (for general text) or 'android_uiautomator_clear_text' (for clearing text), leaving the agent to infer based on context.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jduartedj/android-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server