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_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.
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. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds the optional page-filtering behavior and clarifies the exact scope (widgets belonging to a template). It does not disclose edge cases like empty results, but for a read-only list with an output schema, this is sufficient.

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?

The description is a single, concise sentence that front-loads the primary action and includes the key optional filter. Every word contributes value; there is no redundant phrasing or excessive detail.

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 is complete for a read-only listing tool: it names the resource scope, the optional filter, and relies on the output schema for return details. With annotations covering the safety profile and schema covering parameters, nothing essential is missing for an agent to call it 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?

Both parameters are fully described in the schema, including provenance references (list_templates and list_pages). The tool description adds no additional semantic meaning beyond the schema, which already documents the parameters thoroughly. With 100% schema coverage, a baseline 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 clearly states the operation: listing widgets that belong to a template, with an optional filter to a single page. It distinguishes from other list tools by specifying the parent resource (template) and explicitly mentioning the optional page filter, making its purpose unambiguous.

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 implies when to use this tool (when you need widgets of a specific template) but does not explicitly compare it with siblings like list_asset_widgets or list_widgets. However, the template-scoped semantics make the appropriate context clear, and the optional filter adds practical 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