Skip to main content
Glama
Sign In
SmartSuite MCP Server

SmartSuite MCP Server

by SmartSuiteFoundry
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

smartsuite_describe_dashboard

Read-only

Fetch full configuration for a SmartSuite dashboard: tabs, footer/branding, style, sharing, and optionally all widget details.

Instructions

Get the full configuration for a single SmartSuite dashboard: tabs, footer/branding, style, and sharing settings. Set includeWidgets:true to also fetch every widget on every tab (type, name, position, size, and parsed params). Widget types include content widgets (hero, simple-banner, heading, faq, text-block, divider) and data widgets (chart, pivot, summary-card, progress, comparison, list-view, card-view, kanban-view, calendar-view, timeline-view, record-details, filter, data-schema).

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": {
      "applicationId": "<applicationId>",
      "dashboardId": "<dashboardId>"
    },
    "name": "smartsuite_describe_dashboard"
  }
}

Input Schema

NameRequiredDescriptionDefault
dashboardIdYesThe dashboard (report) ID
applicationIdYesThe application ID
includeWidgetsNoFetch all widgets for every tab. Default false. Each tab triggers one extra API call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.8

TDQS

A4.7/5.0
Behavior5/5

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

Annotations declare readOnlyHint=true, and the description adds value by detailing the returned data (tabs, footer, etc.) and the behavioral impact of includeWidgets (triggering extra API calls per tab). No contradictions; the description enhances transparency beyond annotations.

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 the core purpose, second expands on includeWidgets with widget types and cost. Every sentence adds value, no redundancy, and critical info is front-loaded.

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 no output schema, the description adequately explains the return value (tabs, footer/branding, etc.) and widget details. It covers the complexity of dashboard configuration and even notes API call implications. No missing elements for a read tool with annotations.

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 description coverage is 100%, so baseline is 3. The description adds extra meaning by listing widget types for includeWidgets and explaining its behavior, improving upon the schema's brief text. The other parameters (IDs) are well-documented in the schema, so no further addition needed.

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 'Get the full configuration for a single SmartSuite dashboard' with a specific verb and resource. It lists the components (tabs, footer/branding, style, sharing settings) and distinguishes from siblings like smartsuite_list_dashboards (list vs. single) and create/update tools.

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 usage when needing a dashboard's full configuration and mentions the includeWidgets parameter's API cost, but does not explicitly state when not to use it or directly reference alternatives like list_dashboards. It provides clear context but lacks exclusions.

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

Deploy Server

Other Tools