Skip to main content
Glama

add_widget

Destructive

Add a saved query visualization to a dashboard as a widget. Specify the dashboard and visualization IDs to place it and receive the widget and dashboard IDs.

Instructions

Add a saved query's visualization onto a dashboard as a widget. Behavior: places the widget and returns its id and dashboard_id. Usage: get the dashboard_id from list_dashboards or create_dashboard, and the visualization_id from get_query (each saved query exposes its visualizations). This is how you build up a dashboard after creating it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textNoOptional text/markdown caption shown on the widget
widthNoWidget width: 1 = half row, 2 = full row (default 1)
dashboard_idYesID of the dashboard to add the widget to (from list_dashboards/create_dashboard)
visualization_idYesID of the visualization to embed (from get_query's visualizations list)
Behavior4/5

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

Annotations declare destructiveHint: true, and the description mentions the mutation ('places the widget') and its return values (id and dashboard_id). However, it does not elaborate on potential side effects or prerequisites like permissions, which could be helpful for a mutation tool.

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 two concise sentences without fluff: first states purpose, second provides usage guidance. It is front-loaded and efficient.

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 prerequisites, usage steps, and return values. Without an output schema, it adequately informs the agent of what to expect. No gaps are apparent.

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 the description adds only minor context (sources for dashboard_id and visualization_id). This is adequate, as the schema already documents each parameter's meaning.

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 action ('Add') and resource ('a saved query's visualization onto a dashboard as a widget'), and distinguishes this tool from siblings like create_dashboard or get_dashboard by specifying its role in building dashboards.

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 explicitly tells when to use this tool (to build up a dashboard after creating it) and how to obtain the required parameters: dashboard_id from list_dashboards or create_dashboard, and visualization_id from get_query.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/seob717/redash-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server