Skip to main content
Glama

click_element

Invoke buttons, menu items, or links in native Windows apps by name or automationId via UIA InvokePattern, avoiding screen coordinates while verifying the target window first.

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": include UIA diff in post.rich (appeared/disappeared/valueDeltas, and nameDeltas when an element's name changed, such as a calculator display) — usually removes the need for a verification screenshot. It is withheld, with post.rich.diffDegraded saying why, when the diff cannot be shown to describe the window that was acted on. On click_element and keyboard (and set_element_value where the server registers it), which resolve the target window before acting: another open window's title contains the text this call resolved to, whether you named the hwnd or the server did — "@active" and the dialog rescue both resolve one ("ambiguous_title"); or the target moved between the snapshot and the action ("target_changed"). On those and on mouse_click, retrying with a fixId also withholds it, because the stored fix names a window this cannot see ("fix_target_unknown") — browser tools keep their diff on a fixId retry, because theirs is a tab diff and does not depend on a window title. mouse_click and mouse_drag accept an hwnd and still take their snapshots by windowTitle, so nothing else is withheld for them: verify those with a screenshot. A window too large to read whole is withheld too ("tree_truncated"). The action itself is unaffected in every case; only the diff is. Default: "minimal".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. Changed3 schema fields changedv2.3.1
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • removedInput schema / additionalProperties
      Removed value: -false
    • changedInput schema / properties / narrate / description
      Previous 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."New value: +"Narration level. \"rich\": include UIA diff in post.rich (appeared/disappeared/valueDeltas, and nameDeltas when an element's name changed, such as a calculator display) — usually removes the need for a verification screenshot. It is withheld, with post.rich.diffDegraded saying why, when the diff cannot be shown to describe the window that was acted on. On click_element and keyboard (and set_element_value where the server registers it), which resolve the target window before acting: another open window's title contains the text this call resolved to, whether you named the hwnd or the server did — \"@active\" and the dialog rescue both resolve one (\"ambiguous_title\"); or the target moved between the snapshot and the action (\"target_changed\"). On those and on mouse_click, retrying with a fixId also withholds it, because the stored fix names a window this cannot see (\"fix_target_unknown\") — browser tools keep their diff on a fixId retry, because theirs is a tab diff and does not depend on a window title. mouse_click and mouse_drag accept an hwnd and still take their snapshots by windowTitle, so nothing else is withheld for them: verify those with a screenshot. A window too large to read whole is withheld too (\"tree_truncated\"). The action itself is unaffected in every case; only the diff is. Default: \"minimal\"."
  2. 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."
  3. Addedv1.12.0
  4. Removedv1.10.4
  5. Addedv1.9.2
  6. Removedv1.8.0
  7. Addedv1.6.0
  8. Removedv1.5.1
  9. Addedv1.5.0
  10. Removedv1.4.3
  11. Addedv1.4.2
  12. Removedv1.4.0
  13. 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"
      +}
  14. Addedv1.1.3
  15. Removedv1.1.1
  16. Addedv1.0.3
  17. Removedv0.15.7
  18. 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."
  19. Changed1 schema field changedv0.13.1
    • addedInput schema / properties / fixId
      Added value: +{
      +  "description": "Approve a pending suggestedFix (one-shot, 15s TTL).",
      +  "type": "string"
      +}
  20. 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"
      +]
  21. First observedv0.6.2

TDQS

A4.4/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden — and it does disclose meaningful behavior: auto-guarding on windowTitle (identity/foreground/modal), the perception envelope return, and typed error codes with recovery paths. However, it omits the return shape beyond post.perception.status and never states permission or side-effect profile beyond 'invoke', leaving some behavioral burden unmet for a no-annotation tool.

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

Conciseness4/5

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

Front-loaded with purpose and routing in the first two sentences, with caveats last. It is long, but nearly every clause is actionable (error codes, recovery choice, fallback), so little is filler.

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?

With no output schema, the description compensates by describing the perception envelope and post.rich diff behavior, plus typed errors and recovery steps. For a 9-parameter invocation tool with no annotations, this is complete enough to call correctly.

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, but the description adds genuine meaning beyond the schema: windowTitle triggers identity/foreground/modal guarding, fixId re-targets after window-identity drift, and lensId is scoped to advanced pinned-lens use. This is more than the raw schema conveys.

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?

States a specific verb (invoke) and resource (UI element by name or automationId) with the mechanism (UIA InvokePattern) and the constraint (no screen coordinates). It explicitly distinguishes itself from mouse_click, so an agent can route between them without opening either schema.

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?

Gives explicit when-to-use (buttons, menu items, links in native Windows apps) and when-not ('Prefer over mouse_click'), plus a workflow prerequisite ('Use desktop_discover first to discover automationIds') and a fallback rule for unsupported controls.

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