Skip to main content
Glama
speakai

Speak AI MCP Server

Official
by speakai

Get Dashboard

get_dashboard
Read-onlyIdempotent

Retrieve the complete configuration of a dashboard, including its widgets, filters, date range, and folder scope, to analyze or replicate its setup.

Instructions

Get a single dashboard's full config (widgets, filters, date range, folder scope).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dashboardIdYesDashboard business id (the dashboardId field from list_dashboards, not the Mongo _id)

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?

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds value by specifying what the response contains (widgets, filters, date range, folder scope), beyond what annotations provide.

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, efficient sentence. Every word conveys essential information without redundancy or unnecessary elaboration.

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?

Given that the tool has an output schema (not shown but indicated), the description does not need to explain return values. It specifies the key elements of the response, and the parameter is fully covered by the schema. This is complete for a simple retrieval tool.

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?

There is only one parameter, dashboardId, which is fully described in the input schema (including type, requirement, and clarification about it being a business id, not Mongo _id). The description does not add any additional parameter details, so baseline 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 ('Get'), the resource ('a single dashboard'), and the scope ('full config') including specific elements (widgets, filters, date range, folder scope). This effectively distinguishes it from sibling tools like list_dashboards, update_dashboard, or get_dashboard_speakers_insight.

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 that this tool is for retrieving the complete configuration of one dashboard, which is a specific use case. While it does not explicitly state when not to use it or name alternatives, the context of sibling tools makes the usage clear enough.

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