Skip to main content
Glama

Control Checkbox Set

control_checkbox_set
Destructive

Set a rendered non-parameter checkbox in the current Data Studio view to true or false, or clear it with null; uses an interaction fingerprint to guard against same-document conflicts.

Instructions

Set a rendered non-parameter checkbox in the current View document.

True/False select a boolean filter; null clears it (not reset-to-default). Get the fingerprint from component_interaction_state. Durable before-state, native same-document conflict guard and read-back; no automatic retries. operation_restore restores its previous runtime state only in that same document, rejecting intervening changes. Reload expires runtime recovery. Does not change saved defaults. Verification covers control state and saved page, not consumer query completion. Parameters/Analysis are unsupported.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "page_id": "<page_id>",
      "component_id": "<component_id>",
      "value": "<value>",
      "expected_interaction_fingerprint": "<expected_interaction_fingerprint>"
    },
    "name": "control_checkbox_set"
  }
}

Input Schema

NameRequiredDescriptionDefault
valueYes
dry_runNo
page_idYes
report_idNo
component_idYes
expected_interaction_fingerprintYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.5

TDQS

A4.3/5.0
Behavior5/5

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

Annotations only say readOnlyHint=false and destructiveHint=true; the description goes far beyond by disclosing durable before-state capture, a native same-document conflict guard, read-back verification, and no automatic retries. It also scopes the blast radius precisely: runtime recovery expires on reload, saved defaults are untouched, and verification covers control state plus saved page but not consumer query completion.

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, then layered with semantics, preconditions, and behavioral caveats; nearly every clause carries information. A few lines are telegraphic to the point of ambiguity ("Verification covers control state and saved page, not consumer query completion"), costing some readability.

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

Completeness4/5

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

For a destructive mutation with six parameters and an output schema, the definition covers conflict handling, retry policy, restore scope, and verification limits well. The notable gap is the unmentioned dry_run default of true, which an agent needs in order to know whether a call actually mutates state.

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 0%, so the description must carry the parameter burden, and it only partly does. It adds real meaning for value (true/false select a boolean filter; null clears rather than reset-to-default) and for expected_interaction_fingerprint (source tool), but says nothing about dry_run — which defaults to true and therefore changes default invocation behavior — nor about page_id, component_id, or report_id.

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 and resource with scope: "Set a rendered non-parameter checkbox in the current View document." The qualifier "non-parameter" and the closing "Parameters/Analysis are unsupported" cleanly separate it from parameter-control siblings, and the null/boolean semantics pin down exactly what is being set.

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

Usage Guidelines4/5

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

Gives concrete preconditions ("Get the fingerprint from component_interaction_state") and routes restoration behavior to operation_restore, including its same-document restriction. It never states an explicit alternative for the unsupported parameter/analysis cases beyond declaring them unsupported, so it stops short of full when-to-use/when-not routing.

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

Deploy Server

Other Tools