Skip to main content
Glama

List template widgets

list_template_widgets
Read-only

List the widgets that belong to a template (optionally filtered to a single page).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesTemplate ID (from list_templates).
page_idNoFilter to widgets on a single page, id from list_template_pages.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoOne row per widget in the template — id, name, type, chart, its datasource and query, and its position on the page.
metaNoPage, limit and total row count.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedInput schema / properties / page_id / description
      Previous value: -"Filter to widgets on a single page, id from list_pages."New value: +"Filter to widgets on a single page, id from list_template_pages."
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / properties / meta / description
      Previous value: -"Pagination for the list — page, limit and the total row count."New value: +"Page, limit and total row count."
    • changedOutput schema / properties / meta / properties / limit / description
      Previous value: -"Maximum rows per page."New value: +"Max rows per page."
    • changedOutput schema / properties / meta / properties / page / description
      Previous value: -"Zero-based index of the page returned."New value: +"Page index, zero-based."
    • changedOutput schema / properties / meta / properties / total / description
      Previous value: -"Total rows matching the query across all pages."New value: +"Total rows matching the query."
    • 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.1/5.0
Behavior3/5

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

Annotations already declare this a read-only, non-destructive operation, so the description does not need to repeat that. It adds minimal behavioral context beyond the schema—just the template and page scoping—and no hidden side effects are disclosed or implied.

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 states the core action and the optional refinement with no filler. Every part earns its place.

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?

For a simple read-only list operation with an output schema, full parameter documentation, and safety annotations, the description provides enough context for an agent to invoke it correctly. No critical behavioral or prerequisite information is missing.

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 100% for both id and page_id, so the schema carries the parameter documentation burden. The description's mention of optional page filtering adds no new semantic detail beyond what the schema already states.

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 names the specific resource (widgets belonging to a template) and the operation (list), with an optional page filter. This clearly distinguishes it from related siblings like list_widgets and list_asset_widgets based on scope.

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?

The description makes the intended use obvious: retrieve widgets scoped to a template, optionally narrowed to a page. It does not explicitly name alternative tools or state when not to use it, but the template-scoped wording gives clear contextual guidance.

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