Skip to main content
Glama

Create Dashboard Widget

widget.create

Add a chart or number to a dashboard, in the shape steps.draft uses, with field names: type NUMBER, COLUMN, BAR, LINE, AREA or GAUGE; series: [{ legend, fn: { functionTypes: ["SUM"], params: [{ type: "ATTRIBUTE", value: "Amount" }] } }] (COUNT takes params: []); a chart that groups adds groupBy: { type: "PROPERTY", property: "Stage" }. A NUMBER tile takes an icon and options.withoutGroup: true. Place it with options.position: { x, y, cols, rows } on a 24-column grid.

Input Schema

NameRequiredDescriptionDefault
iconNo
nameYes
typeYes
filterNoRows the whole widget counts
seriesNo
groupByNo
optionsNoe.g. `position: { x, y, cols, rows }` on a 24-column grid; a NUMBER tile takes `withoutGroup: true`
subGroupNoField name or code that splits each group
dashboardIdYes

Output Schema

NameRequiredDescriptionDefault
nameYes
widgetIdYes
dashboardIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false, so the agent knows this is a non-idempotent write. The description adds substantive behavioral context beyond that: the type-specific rules (COUNT takes params: [], NUMBER takes icon and options.withoutGroup) and the 24-column placement grid. It doesn't discuss permissions or dashboardId validity, but against the annotation baseline this is solid added value.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded paragraph that moves from the action to the payload shape to placement, with every clause carrying concrete spec information. It is dense and heavy on inline code, but no sentence is redundant.

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?

With 9 parameters, deep nesting, and an output schema present, the description covers the hard parts (series, groupBy, options) but leaves `filter` – which controls which rows the whole widget counts – and `subGroup` entirely undocumented, plus no mention of the required dashboardId. Adequate for the common chart case, incomplete for filtered/sub-grouped widgets.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 33%, so the description carries real weight and largely delivers: it gives literal payload examples for series.fn.functionTypes/params, the PROPERTY groupBy shape, options.position, and icon. It omits the `filter` parameter, `subGroup`, `name`, and `dashboardId`, and its type list drops COMBO which the schema enum allows – a minor inconsistency, not a contradiction.

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?

Opens with a concrete verb+resource: 'Add a chart or number to a dashboard', which is clearly distinct from widget.update / widget.delete. It does not explicitly name a sibling or state what happens if the widget already exists, but the create semantics are unambiguous.

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

Usage Guidelines3/5

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

The phrase 'in the shape steps.draft uses' hints at the intended workflow context, but there is no explicit when-to-use or when-not-to-use guidance and no routing to widget.update for modification. Usage is only implied.

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