Skip to main content
Glama

List widgets

list_widgets
Read-only

List all widgets for a source (report or template).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
page_idNoFilter by page ID (from list_pages).
source_idYesSource ID — report (from list_reports) or template (from list_templates) ID.
source_typeNo'project' or 'template'

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoOne row per widget — id, name, type, chart, its datasource and query, its state, and its position on the page. Read the numbers themselves with get_widget_data.
metaNoPagination for the list — page, limit and the total row count.
successYesTrue when the call succeeded. A failure comes back as an error result instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "data": {
      +      "description": "One row per widget — id, name, type, chart, its datasource and query, its state, and its position on the page. Read the numbers themselves with get_widget_data.",
      +      "items": {},
      +      "type": "array"
      +    },
      +    "meta": {
      +      "additionalProperties": true,
      +      "description": "Pagination for the list — page, limit and the total row count.",
      +      "properties": {
      +        "limit": {
      +          "description": "Maximum rows per page.",
      +          "type": "number"
      +        },
      +        "page": {
      +          "description": "Zero-based index of the page returned.",
      +          "type": "number"
      +        },
      +        "total": {
      +          "description": "Total rows matching the query across all pages.",
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "success": {
      +      "description": "True when the call succeeded. A failure comes back as an error result instead.",
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the read-only nature is covered. The description adds that it lists 'all' widgets and specifies the source type, which is some context. However, it does not disclose pagination, ordering, or whether it returns full widget data. Given the annotations, a 3 is appropriate – the description adds minimal value beyond annotations.

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?

A single, front-loaded sentence with no filler. Every word contributes to the purpose. It is as concise as possible while remaining informative.

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

Completeness3/5

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

The output schema exists, so return values are covered. However, the description lacks guidance on how this tool differs from sibling list tools and contains a minor terminology mismatch ('report' vs 'project' in the enum). For a simple list tool with many siblings, this is not fully complete – it should at least hint at when to use it.

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?

The schema description coverage is 100%, so parameters are already well documented. The description adds no additional meaning about parameters, just restates the source scope. Baseline 3 is correct because the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the verb 'List', the resource 'widgets', and the scope 'for a source (report or template)'. It clearly indicates what the tool does, though it does not differentiate from sibling tools like list_asset_widgets or list_template_widgets. The purpose is unambiguous but not explicitly contrasted with alternatives.

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

Usage Guidelines2/5

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

There is no guidance on when to use this tool versus the many sibling list tools (e.g., list_asset_widgets, list_template_widgets). The description only states what it does, not when to choose it. An agent would have to infer from the name and schema, which is not sufficient for a tool with overlapping siblings.

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