Skip to main content
Glama

Refresh widgets

refresh_widgets
Idempotent

Re-fetch specific widgets with their saved config and save the results. Configuring a widget with update_data_widget already refreshes it, so this is for re-reading without a config change. Returns immediately; the fetch runs in the background — call get_widget_data with the same widget_ids to read the numbers as they land. To refresh a whole report, use refresh_report.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
timezoneNoIANA timezone the dates are read in. Defaults to the client's own timezone
client_idNoClient the widgets belong to (from list_clients). Read from the widgets when omitted.
date_rangeNoExplicit range to fetch against. Defaults to each widget's own range, or its report's.
widget_idsYesWidgets to refresh (ids from list_widgets)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoAcknowledgement that the refresh was accepted. The fetches run in the background — read the numbers with get_widget_data using the same widget_ids.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / client_id / description
      Previous value: -"Client id the widgets belong to (from list_clients)"New value: +"Client the widgets belong to (from list_clients). Read from the widgets when omitted."
    • changedInput schema / properties / date_range / description
      Previous value: -"The date range to fetch against"New value: +"Explicit range to fetch against. Defaults to each widget's own range, or its report's."
    • changedInput schema / required
      Previous value: -[
      -  "widget_ids",
      -  "client_id",
      -  "date_range"
      -]New value: +[
      +  "widget_ids"
      +]
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / success / description
      Previous value: -"True when the call succeeded. A failure comes back as an error result instead."New value: +"True when the call succeeded."
  2. First observed

TDQS

A4.7/5.0
Behavior5/5

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

The description discloses the critical async behavior — 'Returns immediately; the fetch runs in the background' — and tells the caller how to observe the results. This adds value beyond the annotations by explaining the timing and side effects of the operation.

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?

Four sentences, all densely informative: purpose, contrast with update_data_widget, async behavior and follow-up call, and sibling alternative refresh_report. No filler, no repetition of schema content, and the key purpose is front-loaded.

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?

The description covers purpose, usage boundaries, async behavior, how to read results, and the sibling for whole-report refresh. With annotations and an output schema present, nothing essential is missing for an agent to invoke and follow up correctly.

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 coverage is 100%, so all parameters are already documented in the schema. The description adds contextual framing around widget_ids and saved config but does not materially extend the parameter semantics, so the baseline score of 3 is appropriate.

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 ('Re-fetch specific widgets with their saved config and save the results'), and explicitly contrasts itself with update_data_widget and refresh_report, making the tool's identity unmistakable among its many siblings.

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?

It gives explicit when-to-use guidance: use when re-reading without a config change, since update_data_widget already refreshes on config. It also directs the agent to refresh_report for whole reports and to get_widget_data for reading results, leaving no ambiguity about when to select this tool versus alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources