Skip to main content
Glama

click_element

Click any UI element in native Windows apps by name or automationId, without screen coordinates. Uses UIA InvokePattern with automatic window-identity and modal guards for reliable interaction.

Instructions

Invoke a UI element by name or automationId via UIA InvokePattern — no screen coordinates needed. The server auto-guards using windowTitle (verifies identity, foreground, modal) and returns post.perception.status. Prefer over mouse_click for buttons, menu items, and links in native Windows apps. Use desktop_discover first to discover automationIds. Pass fixId from a suggestedFix to re-target after window identity drift. lensId is optional for advanced pinned-lens use. Caveats: Typed errors: code:'InvokePatternNotSupported' — the control does not expose InvokePattern, fall back to mouse_click; code:'ElementDisabled' — the element is in a disabled state, re-check preconditions before retry; code:'GuardFailed' — read the perception envelope (attention / guard fields) and choose recovery (re-focus, wait, or pass the suggestedFix.fixId on the next call). Some custom controls do not expose InvokePattern at all; fall back to mouse_click for those.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hwndNoDirect window handle ID (takes precedence over windowTitle). String to avoid 64-bit precision issues.
nameNoElement name/label (partial match, case-insensitive)
fixIdNoApprove a pending suggestedFix (one-shot, 15s TTL).
lensIdNoOptional perception lens ID. Guards (safe.keyboardTarget, target.identityStable) are evaluated before clicking, and a perception envelope is attached to post.perception on success.
includeNoOptional response-shape opt-in. `['envelope']` returns the self-documenting envelope (`_version` / `data` / `as_of` / `confidence`). `['raw']` forces raw shape (overrides DESKTOP_TOUCH_ENVELOPE=1 server default). Default behaviour is raw shape (compat with existing clients).
narrateNoNarration level. rich includes UIA or browser state diff when supported, and is withheld with post.rich.diffDegraded when the diff cannot be shown to describe the window that was acted on.minimal
controlTypeNoControl type filter, e.g. 'Button', 'MenuItem'
windowTitleYesPartial window title of the target window. Use '@active' for the current foreground window.
automationIdNoExact AutomationId of the element

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.0.0
    • changedInput schema / properties / narrate / description
      Previous value: -"Narration level. rich includes UIA or browser state diff when supported."New value: +"Narration level. rich includes UIA or browser state diff when supported, and is withheld with post.rich.diffDegraded when the diff cannot be shown to describe the window that was acted on."
  2. Addedv1.12.0
  3. Removedv1.10.4
  4. Addedv1.9.2
  5. Removedv1.8.0
  6. Addedv1.6.0
  7. Removedv1.5.1
  8. Addedv1.5.0
  9. Removedv1.4.3
  10. Addedv1.4.2
  11. Removedv1.4.0
  12. Changed1 schema field changedv1.2.1
    • addedInput schema / properties / include
      Added value: +{
      +  "description": "Optional response-shape opt-in. `['envelope']` returns the self-documenting envelope (`_version` / `data` / `as_of` / `confidence`). `['raw']` forces raw shape (overrides DESKTOP_TOUCH_ENVELOPE=1 server default). Default behaviour is raw shape (compat with existing clients).",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  13. Addedv1.1.3
  14. Removedv1.1.1
  15. Addedv1.0.3
  16. Removedv0.15.7
  17. Changed2 schema fields changedv0.15.4
    • addedInput schema / properties / hwnd
      Added value: +{
      +  "description": "Direct window handle ID (takes precedence over windowTitle). String to avoid 64-bit precision issues.",
      +  "maxLength": 20,
      +  "type": "string"
      +}
    • changedInput schema / properties / windowTitle / description
      Previous value: -"Partial window title of the target window"New value: +"Partial window title of the target window. Use '@active' for the current foreground window."
  18. Changed1 schema field changedv0.13.1
    • addedInput schema / properties / fixId
      Added value: +{
      +  "description": "Approve a pending suggestedFix (one-shot, 15s TTL).",
      +  "type": "string"
      +}
  19. Changed10 schema fields changedv0.10.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / _stub
      Removed value: -{
      -  "description": "Stub tool — arguments ignored."
      -}
    • addedInput schema / properties / automationId
      Added value: +{
      +  "description": "Exact AutomationId of the element",
      +  "maxLength": 200,
      +  "type": "string"
      +}
    • addedInput schema / properties / controlType
      Added value: +{
      +  "description": "Control type filter, e.g. 'Button', 'MenuItem'",
      +  "maxLength": 100,
      +  "type": "string"
      +}
    • addedInput schema / properties / lensId
      Added value: +{
      +  "description": "Optional perception lens ID. Guards (safe.keyboardTarget, target.identityStable) are evaluated before clicking, and a perception envelope is attached to post.perception on success.",
      +  "type": "string"
      +}
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "Element name/label (partial match, case-insensitive)",
      +  "maxLength": 200,
      +  "type": "string"
      +}
    • addedInput schema / properties / narrate
      Added value: +{
      +  "default": "minimal",
      +  "description": "Narration level. rich includes UIA or browser state diff when supported.",
      +  "enum": [
      +    "minimal",
      +    "rich"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / windowTitle
      Added value: +{
      +  "description": "Partial window title of the target window",
      +  "maxLength": 200,
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "windowTitle"
      +]
  20. First observedv0.6.2

TDQS

A4.9/5.0
Behavior5/5

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

With no annotations, the description bears full behavioral disclosure burden. It goes beyond basics: explains server-side guarding using windowTitle, the return of post.perception.status, and enumerates typed error codes with precise recovery actions (InvokePatternNotSupported, ElementDisabled, GuardFailed). It also discloses limitations of custom controls. This is exceptional transparency.

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 detailed but tightly structured: purpose, usage guidance, then error handling caveats. Every sentence earns its place—no filler or redundancy. Despite its length, it remains front-loaded with the core purpose and immediately actionable guidance, making it efficient for an agent to parse.

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

Completeness5/5

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

For a tool with 9 parameters, no annotations, and no output schema, the description covers all essential contextual aspects: purpose, prerequisites (desktop_discover), selection criteria, error recovery, and limitations. It omits nothing an agent needs to call it correctly. The schema handles parameter details, and the description handles decision-making and error handling comprehensively.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3. The description adds value beyond schema by explaining the intent of fixId ('re-target after window identity drift') and lensId ('advanced pinned-lens use'), and mentions that include and narrate affect response shape. While the schema already documents each parameter, these contextual clarifications improve agent comprehension.

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 states a specific verb and resource: 'Invoke a UI element by name or automationId via UIA InvokePattern — no screen coordinates needed.' It clearly differentiates from siblings like mouse_click and browser_click by identifying the use case (native Windows UI controls) and explicitly naming alternative tools. This is a precise, actionable purpose.

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

Usage Guidelines5/5

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

The description provides explicit when-to-use guidance: 'Prefer over mouse_click for buttons, menu items, and links in native Windows apps.' It also instructs to 'Use desktop_discover first to discover automationIds' and explains when to pass fixId. It even describes fallback cases, e.g., 'fall back to mouse_click' when InvokePattern is unsupported. No ambiguity remains about selecting this tool vs alternatives.

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