Skip to main content
Glama
SmartSuiteFoundry

SmartSuite MCP Server

by SmartSuiteFoundry
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

smartsuite_update_view

Update a SmartSuite view's name, description, filters, sort, groupBy, visible fields, and layout settings. Refuses forms/dashboards; requires schema-write mode.

Instructions

Update a view (report): rename it (label), change its description, and/or change its configuration — visibleFields, filters (+filterOperator), sort, groupBy. Requires readwrite/admin mode AND SMARTSUITE_ENABLE_SCHEMA_WRITE=true. Only the parts you pass are changed; each provided config window replaces that window (e.g. passing sort replaces the sort rules). Field slugs are validated. Refuses forms/dashboards (use their own tools). Use smartsuite_list_views / smartsuite_describe_view to find the viewId and current settings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoReplacement sort rules [{field, direction}] (optional).
labelNoNew name (optional; checked for uniqueness).
viewIdYesThe view (report) ID to update.
filtersNoReplacement filter conditions [{field, comparison, value}] (optional).
groupByNoReplacement group-by rules (optional).
stackByNoKANBAN only, and required for one to work: the status/single-select field slug whose values become the columns. Not the same as groupBy.
dateFieldNoCALENDAR only, and required for one to work: the date-type field slug records are placed on. Omitting it creates a blank calendar.
swimlaneByNoKANBAN only: optional second axis (rows).
descriptionNoNew description (optional).
visibleFieldsNoReplacement visible field slugs (optional).
filterOperatorNoAND/OR for filters (default and).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.0.3
    • addedInput schema / properties / dateField
      Added value: +{
+  "description": "CALENDAR only, and required for one to work: the date-type field slug records are placed on. Omitting it creates a blank calendar.",
+  "type": "string"
+}
    • addedInput schema / properties / stackBy
      Added value: +{
+  "description": "KANBAN only, and required for one to work: the status/single-select field slug whose values become the columns. Not the same as groupBy.",
+  "type": "string"
+}
    • addedInput schema / properties / swimlaneBy
      Added value: +{
+  "description": "KANBAN only: optional second axis (rows).",
+  "type": "string"
+}
  2. First observedv0.9.8

TDQS

A4.9/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=false; the description goes well beyond by disclosing auth/env prerequisites, patch semantics ('Only the parts you pass are changed; each provided config window replaces that window'), slug validation, and refusal behavior for forms/dashboards.

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?

Front-loads the purpose, then prerequisites, then mutation semantics, then discovery/routing instructions. Dense but every sentence carries distinct operational information with no filler.

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?

For an 11-parameter mutation tool with no output schema, the description covers prerequisites, patch/replace semantics, validation, refusals, and how to locate the target view. An agent has everything needed to invoke it correctly.

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 100% so the baseline is 3, but the description adds crucial replace-window semantics ('passing sort replaces the sort rules') plus the note that filterOperator pairs with filters and that field slugs are validated, which the schema does not convey.

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?

States a specific verb 'Update' with the resource 'view (report)' and enumerates the mutable surface (label, description, visibleFields, filters, sort, groupBy). It also explicitly carves out forms/dashboards, making it distinguishable from sibling dashboard/form 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 Guidelines5/5

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

Gives explicit preconditions ('Requires readwrite/admin mode AND SMARTSUITE_ENABLE_SCHEMA_WRITE=true'), tells the agent how to discover inputs ('Use smartsuite_list_views / smartsuite_describe_view to find the viewId and current settings'), and states what not to call it on (forms/dashboards, use their own tools).

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