smartsuite_describe_application
Retrieve a SmartSuite application's schema: field slugs, types, choice options, and record term. Use before creating or updating records to know valid field values.
Instructions
Describe a SmartSuite application schema, including field slugs, types, and options, plus the record term (custom record terminology). Always call this before creating or updating records so you know field slugs and valid values. Set includeLayout:true to also return the record-view layout (sections with collapse flags, and the field row arrangement of the active layout mode). TOKEN COST: the schema is large; a full table is ~1k+ tokens. The schema is STABLE within a session — call this once per table and reuse the result; do NOT re-describe the same application (use forceRefresh only after you change the schema). When you only need field slugs/types/choices (e.g. to build or query records), use verbosity:"compact" or the lighter smartsuite_list_fields instead of the default.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| verbosity | No | Field detail level. "compact" = slug/label/type + choice options + linked-app only (cheapest; use for surveys, CSV/data work, or when scanning many tables). "standard" (default) also adds help text and flags when set. "full" adds the raw params blob (large — only when you need every setting). | |
| forceRefresh | No | Bypass cache and fetch fresh schema. Only needed after the schema changed this session — otherwise redundant. | |
| applicationId | Yes | The application ID | |
| includeFields | No | Include field definitions (default true) | |
| includeLayout | No | Include the record-view layout: { mode, sections (with collapsed flags), rows, hiddenFields }. Default false. |