Skip to main content
Glama
speakai

Speak AI MCP Server

Official
by speakai

Update Dashboard

update_dashboard
DestructiveIdempotent

Partially update a dashboard to change fields like title, description, widgets, or sharing options. To preserve existing widgets, fetch the dashboard before updating.

Instructions

Update a dashboard. Only the fields you pass are changed (partial update). NOTE: passing widgets replaces the entire widget set — fetch the dashboard first if you want to preserve existing widgets.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNoIcon identifier
titleNoNew dashboard name
filtersNoField filters. filters.filterList is an array of { fieldName, fieldOperator?, fieldValue?: string[], fieldCondition? }. Other keys pass through but only filterList is enforced.
widgetsNoWidgets to place on the dashboard, in order. The MCP assigns ids and computes a tidy two-per-row grid layout matching the Speak UI. Just list the widget types you want.
assignToNoUser ids, or group ids in the "<groupId> (G)" convention, to share view access with
dateRangeNoDate range: { preset?, startDate?, endDate? }
isDefaultNoMake this the company default dashboard
dashboardIdYesDashboard business id
descriptionNoDashboard description
folderScopeNoFolder ids to scope analytics to. Empty/omitted = all accessible folders.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoResponse payload from the Speak AI API
Behavior4/5

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

Adds behavioral context beyond annotations: partial update, destructive hint confirmed, and safe usage patterns for widgets. Annotations already indicate destructive=true and idempotent=true, but the description provides concrete details.

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 sentences: first states purpose, second provides a critical usage note. No filler words. Highly efficient.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the rich schema and annotations, the description covers the key behavioral aspects (partial update, widget replacement). With an output schema present, return values are already documented. Slightly lacking in broader context like prerequisites, but sufficient.

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 does not need to add much. The description only adds context for 'widgets' behavior; other parameters are fully documented in the schema.

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 'Update a dashboard' with the verb 'update' and resource 'dashboard', and immediately specifies partial update behavior, distinguishing it from a full replacement.

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?

Provides clear guidance on partial updates and a critical warning about the 'widgets' parameter replacing the entire set, with a recommendation to fetch first if needed. However, no explicit comparison with sibling tools.

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/speakai/speakai-mcp'

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