Skip to main content
Glama

oviond

by com.oviond
OverviewDiscussionsAdmin

List widgets

list_widgets
Read-only

List all widgets on a report or dashboard. For a template, use list_template_widgets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
page_idNoFilter by page ID (from list_pages).
report_idYesReport or dashboard ID (from list_reports).

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.
metaNoPage, limit and total row count.
successYesTrue when the call succeeded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed11 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / properties / report_id
      Added value: +{
+  "description": "Report or dashboard ID (from list_reports).",
+  "type": "string"
+}
    • removedInput schema / properties / source_id
      Removed value: -{
-  "description": "Source ID — report (from list_reports) or template (from list_templates) ID.",
-  "type": "string"
-}
    • removedInput schema / properties / source_type
      Removed value: -{
-  "description": "'project' or 'template'",
-  "enum": [
-    "project",
-    "template"
-  ],
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "source_id"
-]New value: +[
+  "report_id"
+]
    • 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.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 safety profile is covered without description effort. The description adds only the report/dashboard scope context, which is useful but does not disclose additional behavior such as pagination or ordering. With annotations present, this is acceptable.

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?

Two short sentences, front-loaded with the action and scope, with no filler or redundant wording. Every sentence 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 two-parameter read-only list operation with a full output schema and safety annotations, the description is complete. It also closes the main alternative ambiguity by pointing to list_template_widgets.

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%, with both report_id and page_id already described in the input schema. The description adds minimal parameter meaning beyond confirming the report/dashboard scope, so the baseline 3 applies.

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?

Description states a specific verb and resource: 'List all widgets on a report or dashboard.' It also explicitly distinguishes from the sibling list_template_widgets, so an agent can tell them apart immediately.

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?

The description gives a clear when-to-use signal for reports/dashboards and explicitly names the alternative for templates: 'For a template, use list_template_widgets.' This leaves no ambiguity about which sibling to select.

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

All oviond toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources