Skip to main content
Glama

Check a dashboard before publishing

dashboard_check
Read-only

Validate a dashboard spec and actually run its queries, without publishing anything. Returns the problems that would block a publish, the warnings that would not (including design lint: layout, naming, a slow query, a ratio formatted as a percent), and what each query returned — columns with their inferred types, row count, how long it took, and three sample rows with personal data masked — so you can fix a dashboard before it exists. sourcesNotOwned names any connection or Data Set the dashboard reads that is shared with the user rather than theirs and whose owner has not allowed dashboards built from it to be shared (publishable: false in postgres_list_connections / dataset_list): a dashboard reading one stays private to the user however it is shared, so say so before building something they mean to share. Use the same spec shape as dashboard_publish.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "spec": "<spec>"
    },
    "name": "dashboard_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
specYesThe dashboard spec document. See this tool's description.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations only declare readOnly/openWorld/non-destructive; the description adds substantial behavior: it really executes the queries, it distinguishes blocking problems from non-blocking warnings and design lint categories, it describes the per-query result shape, and it calls out that sample rows have personal data masked. It also discloses a non-obvious side effect of readOnly semantics via sourcesNotOwned — a dashboard reading a shared connection stays private regardless of sharing, which the annotations cannot convey.

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?

Purpose and the no-publish constraint are front-loaded, and every clause carries information rather than filler. It is, however, two very long sentences with nested parenthetical lists (lint examples, result field list), which makes the key routing signal harder to extract than a short structured layout would.

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?

With no output schema, the description does the work of explaining return values (problems, warnings, per-query columns/types/row count/duration/samples) in enough detail to interpret the response, and it explains the tricky sourcesNotOwned/publishable semantics. The remaining gap is the spec's own shape, which is deferred entirely to dashboard_publish rather than summarized here.

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 one free-form nested spec object whose schema description is circular ('See this tool's description'), and the description never enumerates the spec's fields. It does add one real pointer — 'Use the same spec shape as dashboard_publish' — which is the only guidance on what to pass, so it is better than nothing but leaves the actual structure to another tool.

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?

Names a specific verb pair (validate a spec and actually run its queries) against a specific resource (dashboard spec), and explicitly bounds the scope with 'without publishing anything'. It also points at the sibling whose spec shape it shares (dashboard_publish), so an agent can distinguish it from dashboard_publish/dashboard_promote without opening a schema.

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?

'so you can fix a dashboard before it exists' plus 'without publishing anything' makes the pre-publish use case clear, and the sourcesNotOwned paragraph tells the agent when the sharing caveat must be surfaced to the user. It stops short of an explicit routing rule such as 'call dashboard_check first, then dashboard_publish' or any statement about when this check can be skipped.

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