Invoke Dialog Action
Invokes one visible, enabled action on one current Tableau Studio dialog. Use a get-active-dialogs result as the only context: copy that item's exact identity and one exact action from its actions array. Never guess a label, invent a close, or retry.
This tool is not read-only and not idempotent. It invokes a live dialog action in Tableau Studio, so repeating the call is not a no-op.
APIs called
This tool acts on the running Tableau Studio instance, not on the Tableau Cloud or Tableau Server REST API. Under the hood this is a call to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x> over the loopback interface, where <x> is the latest API version. There are no OAuth scopes: the call is authorized by the running Tableau Studio instance's per-session bearer token over the loopback interface.
- Selects one current actionable dialog by exact
objectName,title, andclassName, then invokes one visible enabled action copied from that dialog'sactionsarray. Authorized by the session's loopback bearer token. A rejected request never invokes an action.POST /v<x>/app:invokeDialogAction— invoke one exact action on one current dialog. API reference
If the running Tableau Studio instance does not serve POST /v<x>/app:invokeDialogAction, the tool reports that no dialog action ran. Do not retry invoke-dialog-action. Ask the user to handle the dialog.
Required arguments
dialog
Exact identity of the dialog to act on. Type: object. Copy objectName, title, and className from one item returned by get-active-dialogs. All three strings are required and compared exactly, including whitespace. Nested fields:
objectName— object name from that dialog item. Type: stringtitle— window title from that dialog item. Type: stringclassName— window class name from that dialog item. Type: string
A request that matches no current dialog, or that matches more than one, is refused and no action is invoked.
Example
{
"dialog": {
"objectName": "saveChangesDialog",
"title": "Save Changes",
"className": "QMessageBox"
}
}
requestId
Unique logical request ID; preserve it for retries.
action
The one action to invoke on that dialog. Copy one entry from that same item's actions array — not from buttons, and not a reconstructed label. Discriminated by kind:
button— click a labeled button.labelis required, must contain at least one character, and must match that action's exact textclose— invoke a recognized unlabeled close control. Supply{ "kind": "close" }only; alabelis refused
An action that is missing, ambiguous, or disabled is refused and nothing is invoked.
Example (kind: "button")
{
"action": { "kind": "button", "label": "Discard" }
}
Example (kind: "close")
{
"action": { "kind": "close" }
}
Optional arguments
session
Identifier of the target Tableau Studio session. When omitted, the session is resolved automatically (for example, when exactly one Tableau Studio instance is connected or a session has been pinned).
Example
"studio-1"
With no session given and no Tableau Studio instance running, or more than one running, the tool reports an error rather than picking one; the multiple-instance error lists the session IDs to choose from. A session that names an instance which is not among the running ones is refused the same way.
Notes and caveats
- Do not retry after any outcome.
dismissedandaction-invoked-dialog-remainsboth mean the action was invoked.no-active-dialogmeans no action ran because nothing actionable was present. None of those results is a reason to call this tool again. - An unconfirmed call may already have invoked the action. If the request is sent and no valid outcome comes back, do not call this tool again and do not click another action. You may call
get-active-dialogsonce for a fresh inspection; that list does not prove the first click did not happen. Ask the user to handle any remaining choice.
Example results
Dialog dismissed (outcome: "dismissed")
{
"outcome": "dismissed",
"dialog": {
"objectName": "saveChangesDialog",
"title": "Save Changes",
"className": "QMessageBox"
},
"action": { "kind": "button", "label": "Discard" },
"dialogs": []
}
Action invoked, dialog remains (outcome: "action-invoked-dialog-remains")
{
"outcome": "action-invoked-dialog-remains",
"dialog": {
"objectName": "saveChangesDialog",
"title": "Save Changes",
"className": "QMessageBox"
},
"action": { "kind": "button", "label": "Discard" },
"dialogs": [
{
"objectName": "saveChangesDialog",
"title": "Save Changes",
"className": "QMessageBox",
"messageText": "Validation is still running.",
"buttons": ["Discard", "Cancel"]
}
]
}
No active dialog (outcome: "no-active-dialog")
{
"outcome": "no-active-dialog",
"dialogs": []
}
Related
get-active-dialogs— list current dialogs and the exact identity and actions this tool accepts