Skip to main content
Glama
SmartSuiteFoundry

SmartSuite MCP Server

by SmartSuiteFoundry
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

smartsuite_describe_automation_step

Read-only

Resolve a SmartSuite automation step's schema for its trigger or action to view labels, input options, outputs, and condition fields before building or debugging automations.

Instructions

Resolve the full schema of one automation step — its trigger (default) or a chosen action — by calling the automation engine's dynamic description. For a trigger: returns label, inputs (with dropdown options), context outputs, the fields the trigger exposes to downstream actions, and the fields usable in conditions. For an action: returns label, integration, and inputs (with options). Use smartsuite_describe_automation first to see the action list; select an action with actionIndex or actionInstanceId. This view is for UNDERSTANDING a step (labels, types, option values) and is slimmed — do NOT feed it back into update_automation to edit an action; it omits full input encodings (e.g. an AI action's model), and saving a rebuild from it can strip those settings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
stepNoWhich step to resolve (default trigger).
solutionIdYesThe solution ID
actionIndexNoWhen step=action: 0-based index across the automation's actions (default 0).
automationIdYesThe automation ID
actionInstanceIdNoWhen step=action: select the action by its action_reference.instance_id instead of index.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.8

TDQS

A4.9/5.0
Behavior5/5

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

Despite `readOnlyHint` annotation, description adds significant context: it is a read-only inspection tool, not meant for editing, and details the return structure for triggers vs actions, enhancing 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is detailed but efficiently organized, front-loading the core purpose. Each sentence adds value, though slightly longer than minimal.

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?

Despite no output schema, the description explains return fields for both trigger and action, covers all parameters, and warns about limitations, making it fully informative for the tool's complexity.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema coverage, the description adds meaning by explaining default values (step defaults to trigger, actionIndex defaults to 0) and the alternative actionInstanceId selection, clarifying usage beyond 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?

Description clearly states it resolves the full schema of one automation step (trigger or action), distinguishing it from the sibling tool `smartsuite_describe_automation` which describes the whole automation.

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?

Explicitly advises to use `smartsuite_describe_automation` first to get the action list, then choose by index or instance ID. Also warns against using the output directly to update actions, providing clear when-to-use and when-not-to-use guidance.

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